This file is indexed.

/usr/share/doc/libgyoto6-dev/examples/null/README is in libgyoto6-dev 1.2.0-4.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
This is an example of a Gyoto plug-in.

To make your own,

1- choose a cool name;
2- copy this directory (plugins/null/) somewhere;
3- edit configure.ac, lib/Makefile.ac and lib/InitPlug.C: replace any
   occurrence of "null" with your cool name;
4- add new metrics and astrobjs as needed in lib/ and include/, the
   gyoto source code is also full of examples;
5- edit lib/InitPlug.C to register your new classes (rename it to
   CoolPlug.C if you wish);
6- add the name of the required C++ source files to the
   libgyoto_null_la_SOURCES variable in lib/Makefile.am (this variable
   should have been renamed to libgyoto_<cool-name>_la_SOURCES by
   now);
7- run autoreconf (whenever you edit any configure.ac or Makefile.am
   file), then ./configure, make, make install...
8- if installing to default directories (/usr/local/lib), you may need
   to run 'sudo ldconfig'
9- You can now start using your plug-in by loading it with any of the
   available methods:
     - In XML: <Astrobj plugin="null" kind="null"/>
     - On the command line: gyoto -pstdplug,null ...
     - In Python:
          gyoto.requirePlugin('null')
     - In all cases: export GYOTO_PLUGINS="stdplug,null".

For further details, refer to the Gyoto user manual, section entitled
`Writing a C++ plug-in' (as of writing, Sect. 8.2).