debian/indiserver.1

   1 .\"                                      Hey, EMACS: -*- nroff -*-
   2 .\" First parameter, NAME, should be all caps
   3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
   4 .\" other parameters are allowed: see man(7), man(1)
   5 .TH INDISERVER 1 "October 16, 2004"
   6 .\" Please adjust this date whenever revising the manpage.
   7 .\"
   8 .\" Some roff macros, for reference:
   9 .\" .nh        disable hyphenation
  10 .\" .hy        enable hyphenation
  11 .\" .ad l      left justify
  12 .\" .ad b      justify to both left and right margins
  13 .\" .nf        disable filling
  14 .\" .fi        enable filling
  15 .\" .br        insert line break
  16 .\" .sp <n>    insert n+1 empty lines
  17 .\" for manpage-specific macros, see man(7)
  18 .SH NAME
  19 indiserver \- INDI server for telescope control under KStars
  20 .SH SYNOPSIS
  21 .B indiserver
  22 [ \fB\-p\fP \fIport\fP ]
  23 [ \fB\-r\fP \fIattempts\fP ]
  24 [ \fB\-vv\fP ]
  25 \fIdriver\fP [ \fIdriver\fP ... ]
  26 .SH DESCRIPTION
  27 KStars allows you to configure
  28 and control astronomical instruments such as telescopes and focusers via
  29 the INDI protocol.  \fBindiserver\fP is a server that sits between the
  30 KStars user interface and the low-level hardware drivers.
  31 .PP
  32 The INDI server is a network server, in that either local or remote clients
  33 may connect to it to control astronomical instruments.  The INDI server must
  34 be running on the machine that is physically connected to the
  35 astronomical instruments.
  36 .PP
  37 Note that there is no need for you to run the INDI server directly.  Using
  38 the KStars device manager, you can set up astronomical instruments and start
  39 or stop the INDI server all from within KStars.
  40 .PP
  41 You may however choose to run the INDI server manually from the command
  42 line.  In this case you must pass the names of one or more drivers for
  43 individual astronomical instruments.  The current list of available
  44 drivers is:
  45 .PP
  46 .RS
  47 celestrongps (Celestron GPS)
  48 .br
  49 fliccd (Finger Lakes Instruments CCD)
  50 .br
  51 lx200_16 (LX200 16")
  52 .br
  53 lx200autostar (LX200 Autostar)
  54 .br
  55 lx200classic (LX200 Classic)
  56 .br
  57 lx200generic (LX200 Generic)
  58 .br
  59 lx200gps (LX200 GPS)
  60 .br
  61 temma (Temma Takahashi)
  62 .br
  63 v4ldriver (Video4Linux Generic)
  64 .br
  65 v4lphilips (Philips Webcam)
  66 .RE
  67 .PP
  68 Much more detailed information can be found in the KStars Handbook, as
  69 described below.
  70 .PP
  71 KStars is a graphical desktop planetarium for KDE, and forms part of
  72 the official KDE edutainment module.
  73 .SH OPTIONS
  74 .TP
  75 \fB\-p\fP \fIport\fP
  76 Specify the port to listen on (defaults to 7624).
  77 .TP
  78 \fB\-r\fP \fIattempts\fP
  79 Specify the maximum number of restart attempts for each driver (defaults to 2).
  80 .TP
  81 \fB\-vv\fP
  82 Write more verbose output to stderr.
  83 .SH EXAMPLE
  84 To start an INDI server running an LX200 GPS driver and listening to
  85 connections on port 8000:
  86 .PP
  87 .RS
  88 \fIprompt$\fP indiserver -p 8000 lx200gps
  89 .RE
  90 .SH SEE ALSO
  91 .BR celestrongps (1),
  92 .BR fliccd (1),
  93 .BR lx200_16 (1),
  94 .BR lx200autostar (1),
  95 .BR lx200classic (1),
  96 .BR lx200generic (1),
  97 .BR lx200gps (1),
  98 .BR kstars (1),
  99 .BR temma (1),
 100 .BR v4ldriver (1),
 101 .BR v4lphilips (1).
 102 .PP
 103 The KStars Handbook contains detailed information on how to use INDI for
 104 telescope control.  You can read this handbook in the KDE Help Centre.
 105 Alternatively you can enter the URL
 106 \fIhelp:/kstars/indi.html\fP
 107 directly into konqueror or you can run
 108 `\fIkhelpcenter help:/kstars/indi.html\fP'
 109 from the command-line.
 110 .PP
 111 If the KDE Help Centre is not installed then you can install the package
 112 \fIkdeedu-doc-html\fP and read this documentation in HTML format from
 113 \fI/usr/share/doc/kde/HTML/en/kstars/indi.html\fP.
 114 .SH AUTHOR
 115 KStars was written by Jason Harris <jharris@30doradus.org>,
 116 Heiko Evermann <heiko@evermann.de>, Thomas Kabelmann <tk78@gmx.de>,
 117 Pablo de Vicente <pvicentea@wanadoo.es>, Jasem Mutlaq <mutlaqja@ikarustech.com>,
 118 Carsten Niehaus <cniehaus@gmx.de>, Mark Hollomon <mhh@mindspring.com>,
 119 Vincent Jagot <vincent.jagot@free.fr> and
 120 Martin Piskernig <martin.piskernig@stuwo.at>.
 121 .br
 122 This manual page was prepared by Ben Burton <bab@debian.org>
 123 for the Debian GNU/Linux system (but may be used by others).