debian/kstars.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 KSTARS 1 "March 16, 2005"
   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 kstars \- a desktop planetarium for KDE
  20 .SH SYNOPSIS
  21 .B kstars
  22 .RI "[ " generic-options " ]"
  23 [ \fB\-\-date\fP \fIdate-and-time\fP ]
  24 [ \fB\-\-paused\fP ]
  25 .PP
  26 .B kstars \fB\-\-dump\fP
  27 [ \fB\-\-filename\fP \fIimage-file\fP ]
  28 [ \fB\-\-height\fP \fIpixels\fP ] [ \fB\-\-width\fP \fIpixels\fP ]
  29 [ \fB\-\-date\fP \fIdate-and-time\fP ]
  30 [ \fB\-\-script\fP \fIscript-file\fP ]
  31 .SH DESCRIPTION
  32 \fBKStars\fP is a graphical desktop planetarium for KDE.  It depicts an
  33 accurate simulation of the night sky, including stars, constellations,
  34 star clusters, nebulae, galaxies, all planets, the Sun, the Moon,
  35 comets and asteroids.  You can see the sky as it appears from any
  36 location on Earth, on any date.
  37 .PP
  38 The user interface is highly intuitive and flexible.  The display can
  39 be panned and zoomed with the mouse, and you can easily identify
  40 objects and track their motion across the sky.  KStars includes many
  41 powerful features, yet the interface is clean and simple and fun to use.
  42 .PP
  43 Normally KStars launches a full graphical user interface.  By passing the
  44 \fB\-\-dump\fP option, you can make KStars dump an image of the sky to
  45 a graphics file and exit immediately without launching a graphical user
  46 interface at all.  Several other options are available to control
  47 precisely how this image is dumped.
  48 .PP
  49 This application is part of the official KDE edutainment module.
  50 .SH OPTIONS
  51 Below are the kstars-specific options.
  52 For a full summary of options, run \fIkstars \-\-help\fP.
  53 .PP
  54 Options that can be used when starting the full graphical user interface
  55 are as follows.
  56 .TP
  57 \fB\-\-date\fP \fIdate-and-time\fP
  58 Starts with the simulation clock set to the given date and time (default is
  59 current date and time).
  60 .TP
  61 \fB\-\-paused\fP
  62 Starts with the simulation clock paused.
  63 .PP
  64 Options that can be used when dumping an image of the sky are as
  65 follows.
  66 .TP
  67 \fB\-\-dump\fP
  68 Dumps the sky image to a graphics file and exits immediately.
  69 Several other options (described below) are available to control
  70 precisely how the image is dumped.
  71 .TP
  72 \fB\-\-date\fP \fIdate-and-time\fP
  73 Specifies the date and time for the sky image to dump (default is
  74 current date and time).
  75 .TP
  76 \fB\-\-filename\fP \fIimage-file\fP
  77 Dumps the sky image to the given file (default is \fIkstars.png\fP).
  78 .TP
  79 \fB\-\-height\fP \fIpixels\fP
  80 Specifies the height of the sky image to dump (default is 480).
  81 .TP
  82 \fB\-\-script\fP \fIscript-file\fP
  83 Specifies a DCOP script to run before the sky image is dumped.
  84 The script can be used to set where the image is pointing, set the
  85 geographic location, set the time and date, change the zoom level, and
  86 adjust other view options.
  87 .br
  88 KStars includes a script builder (found in the Tools menu) to help
  89 with writing DCOP scripts.  The full user documentation (discussed
  90 below) contains a more detailed explanation of how such scripts can
  91 be written and used.
  92 .TP
  93 \fB\-\-width\fP \fIpixels\fP
  94 Specifies the width of the sky image to dump (default is 640).
  95 .SH SEE ALSO
  96 .BR indiserver (1).
  97 .PP
  98 Full user documentation is available through the KDE Help Centre.
  99 You can also enter the URL
 100 \fIhelp:/kstars/\fP
 101 directly into konqueror or you can run
 102 `\fIkhelpcenter help:/kstars/\fP'
 103 from the command-line.
 104 .PP
 105 If the KDE Help Centre is not installed then you can install the package
 106 \fIkdeedu-doc-html\fP and read this documentation in HTML format from
 107 \fI/usr/share/doc/kde/HTML/en/kstars/\fP.
 108 .SH AUTHOR
 109 KStars was written by Jason Harris <jharris@30doradus.org>,
 110 Heiko Evermann <heiko@evermann.de>, Thomas Kabelmann <tk78@gmx.de>,
 111 Pablo de Vicente <pvicentea@wanadoo.es>, Jasem Mutlaq <mutlaqja@ikarustech.com>,
 112 Carsten Niehaus <cniehaus@gmx.de>, Mark Hollomon <mhh@mindspring.com>,
 113 Vincent Jagot <vincent.jagot@free.fr> and
 114 Martin Piskernig <martin.piskernig@stuwo.at>.
 115 .br
 116 This manual page was prepared by Ben Burton <bab@debian.org>
 117 for the Debian GNU/Linux system (but may be used by others).