Next Previous Up Contents
Next: Examples
Up: doc: Displays STILTS documentation in a web browser
Previous: doc: Displays STILTS documentation in a web browser

### B.7.1 Usage

The usage of `doc` is

       stilts <stilts-flags> doc single=true|false browser=true|false
                                 port=<int-value>
                                 [topic=]<value>

If you don't have the `stilts` script installed, write "`java -jar stilts.jar`" instead of "`stilts`" - see Section 3. The available `<stilts-flags>` are listed in Section 2.1. For programmatic invocation, the Task class for this command is `uk.ac.starlink.ttools.task.DocServer`.

Parameter values are assigned on the command line as explained in Section 2.3. They are as follows:

`browser = true|false` (Boolean)
  If true, an attempt will be made to display the requested documentation in a browser on the desktop. Otherwise, the documentation service will be started and only the URL will be printed to standard output.

  [Default: `true`]

`port = <int-value>` (Integer)
  Preferred port for the HTTP server at which the local host will serve the documentation. If that port is already in use or in certain other circumstances another port may be used.

  [Default: `3535`]

`single = true|false` (Boolean)
  If true, the user document is shown in the browser as a single HTML page; this is rather long but it may be convenient for searching. If false, the multi-page version is displayed. Note in this case the web server generally does not need to continue running in order to explore the document, document, but it is not terminated automatically.

  [Default: `false`]

`topic = <value>` (String)
  If supplied, gives the name of the topic to display initially in the web browser. The whole document will in any case be accessible via normal navigation links. The supplied value may be the name of a STILTS command, filter, output mode, plot layer type, input scheme, or the name (without the `.html` extension) of one of the HTML pages of the SUN/256 document.

Next Previous Up Contents
Next: Examples
Up: doc: Displays STILTS documentation in a web browser
Previous: doc: Displays STILTS documentation in a web browser

STILTS - Starlink Tables Infrastructure Library Tool Set
Starlink User Note256
STILTS web page: http://www.starlink.ac.uk/stilts/
Author email: m.b.taylor@bristol.ac.uk
Mailing list: topcat-user@jiscmail.ac.uk