[skycat] 02/03: Add manpages

Fri Aug 9 15:27:01 UTC 2013

This is an automated email from the git hooks/post-receive script.

olebole-guest pushed a commit to branch debian
in repository skycat.

commit 4c0875d36df4f7730dafada4e444b763a4e64041
Author: Ole Streicher <debian at liska.ath.cx>
Date:   Fri Aug 9 17:25:58 2013 +0200

    Add manpages
---
 debian/manpages           |    5 +
 debian/rtd.man            |  168 +++++++++++++++++++++++++++
 debian/rtdClient.man      |   14 +++
 debian/rtdCubeDisplay.man |   31 +++++
 debian/rtdServer.man      |   47 ++++++++
 debian/skycat.man         |  279 +++++++++++++++++++++++++++++++++++++++++++++
 6 files changed, 544 insertions(+)

diff --git a/debian/manpages b/debian/manpages
new file mode 100644
index 0000000..89ca546
--- /dev/null
+++ b/debian/manpages
@@ -0,0 +1,5 @@
+debian/skycat.man
+debian/rtd.man
+debian/rtdServer.man
+debian/rtdClient.man
+debian/rtdCubeDisplay.man
diff --git a/debian/rtd.man b/debian/rtd.man
new file mode 100644
index 0000000..5b34254
--- /dev/null
+++ b/debian/rtd.man
@@ -0,0 +1,168 @@
+.TH RTD "1" "March 2009" "RTS" "User Commands"
+.SH NAME
+rtd - real-time image display application
+
+.SH SYNOPSIS
+.B rtd
+\fIoptions filename\fR
+
+.SH DESCRIPTION
+The rtd application is used to display FITS images in real-time.
+The application is based on "rtdimage", a Tk image extension
+for displaying FITS images. 
+
+.SH OPTIONS
+.TP
+\fB\-file name\fR
+"name" specifies a FITS format file to load and
+display.
+.TP
+\fB\-subsample bool\fR
+If bool is true, subsampling is used when shrinking
+the image, i.e.: if the image is shrunk by 1/3, only
+every third pixel is displayed. Otherwise, the maximum
+value is taken from the group of pixels.
+.TP
+\fB\-sampmethod n\fR (experimental)
+If option 'subsample' is false, the following methods can be
+used for displaying a shrunk image (i.e. an image with a scale
+factor < 1):
+.IP "0"
+max value of all pixels in a NxN box (default)
+.IP 1
+min value of all pixels in a NxN box
+.IP 2
+mean value of all pixels in a NxN box
+.IP 3
+median value of all pixels in a NxN box
+.IP 4
+max value of pixels on a diagonal cross in a NxN box
+.IP 5
+min value of pixels on a diagonal cross in a NxN box
+.IP 6 
+mean value of pixels on a diagonal cross in a NxN box
+.IP 7
+median value of pixels on a diagonal cross in a NxN box
+.IP 8
+median value of pixels in a chess-board like box
+.IP 9
+median value of a 3x3 box
+.TP
+\fB\-usexshm bool\fR
+If bool is true (default), attempt to use X shared
+memory for the image display, if available. This
+improves performance considerably, but is only
+available when working on the system console.
+
+.TP
+\fB\-usexsync bool\fR
+If true, try to use X synchronisation.
+
+.TP
+\fB\-verbose bool\fR
+If bool is true, diagnostic messages are printed out
+to show what is going on internally (for debugging
+use).
+
+.TP
+\fB\-default_cmap\fR
+This option sets the default colormap file to use when
+starting up.  Only the root of the filename should be
+specified for this option, for example: "ramp" for a grey
+level colormap.  For a list of available colormap files, see
+the colormaps directory in the rtd release.
+
+.TP
+\fB\-min_colors n\fR
+.TP
+\fB\-max_colors n\fR
+Specify the min and max number of colors to allocate before
+using a private colormap.
+
+.TP
+\fB\-default_itt
+This option is similar to \-default_cmap, except it
+sets the default ITT (intensity transfer table) file
+to use at startup.  ITT files are also stored in the
+colormaps directory.
+
+.TP
+\fB\-xscale xs\fR
+.TP
+\fB\-yscale ys\fR
+Set the default scaling factors (default: 1).
+
+.TP
+\fB\-camera name\fR
+Set the camera name for real-time image events:
+default: taken from the RTD_CAMERA environment
+variable, if set, otherwise set to RTDSIMULATOR, for
+simulation test mode.
+
+.TP
+\fB\-zoom_factor number\fR
+Set the scale factor for the zoom window (default 5 x
+the original image).
+
+.TP
+\fB\-colorramp_height h\fR
+Set the height of the colorramp subwindow (default: 20).
+
+.TP
+\fB\-with_zoom_window bool\fR
+If bool is true (default), add a zoom window.
+
+.TP
+\fB\-with_pan_window bool\fR
+If bool is true (default), add a panning window.
+
+.TP
+\fB\-dozoom bool\fR
+If true, turn on zoom window.
+    
+.TP
+\fB\-disp_image_icon bool\fR
+If true, display a copy (view) of the image as an icon.
+
+.TP
+\fB\-drag_scroll bool\fR
+If true, set bindings to scroll with the middle mouse button.
+
+.TP
+\fB\-scrollbars bool\fR
+If true, display scrollbars to scroll the image.
+
+.TP
+\fB\-port port\fR
+ Default port for remote connections (0 means system chooses a
+ port).
+  
+.TP
+\fB\-debug bool\fR
+ Debugging flag: enables real-time simulation with testProg
+ (below).
+
+.TP
+\fB\-testprog path\fR
+For testing: name of test program used to generate real-time
+updates (tRtd).
+
+.TP
+\fB\-interval n\fR
+For testing: interval between updates in ms.
+
+.TP
+\fB\-with_perftest bool\fR
+If true, display performance tester utility in menu bar.
+
+.TP
+\fB\-with_warp bool\fR
+Option to warp the mouse pointer.
+
+.SH FILES
+$RTD_LIBRARY/../demos/rtd.tcl
+
+.SH SEE ALSO
+rtdimage(n), RtdImageCtrl(n), rtdimage_wish(1), rtdServer(1),
+RtdServerTool(n), RtdImageZoom(n), RtdImageZoomView(n)
+
diff --git a/debian/rtdClient.man b/debian/rtdClient.man
new file mode 100644
index 0000000..188de0e
--- /dev/null
+++ b/debian/rtdClient.man
@@ -0,0 +1,14 @@
+.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.41.1.
+.TH RTDCLIENT "1" "March 2009" "RTDCLIENT" "User Commands"
+.SH NAME
+rtdClient - image event client for RTD
+.SH SYNOPSIS
+.B rtdClient
+\fI[\-v]\fR
+.SH DESCRIPTION
+This is the client for the rtdServer.
+.TP
+\fB\-v\fR
+verbose mode
+.SH "SEE ALSO"
+rtdServer(1)
diff --git a/debian/rtdCubeDisplay.man b/debian/rtdCubeDisplay.man
new file mode 100644
index 0000000..19e6ca0
--- /dev/null
+++ b/debian/rtdCubeDisplay.man
@@ -0,0 +1,31 @@
+.TH RTDCUBEDISPLAY "1" "March 2009" "RTDCUBEDISPLAY" "User Commands"
+.SH NAME
+rtdCubeDisplay - simple FITS cube display program
+.SH SYNOPSIS
+.B rtdCubeDisplay
+\fI\-f <filename> \-c <cameraname> [\-l] [\-t msec] [\-v]\fR
+.SH DESCRIPTION
+rtdCubeDisplay displays FITS cube images for the real-time display.
+By specifying a FITS cube file (option \-f) and a camera name (option \-c)
+the images are extracted from the file and an image event is sent to
+the rtdServer. In order to display the image a rtd widget application
+e.g. 'rtd' must register to the same camera name as specified above.
+For the 'rtd' application this is done by  setting the RTD_CAMERA
+environment.
+.TP
+\fB\-f <filename>\fR
+FITS cube images
+.TP
+\fB\-c <cameraname>\fR
+Camera name to identify real time source
+.TP
+\fB\-l\fR
+Loop indefinetly
+.TP
+\fB\-t msec\fR
+Delay time between cube images (in msec) default 500 ms
+.TP
+\fB\-v\fR
+Verbose mode
+.SH "SEE ALSO"
+rtd(1)
diff --git a/debian/rtdServer.man b/debian/rtdServer.man
new file mode 100644
index 0000000..7b737f5
--- /dev/null
+++ b/debian/rtdServer.man
@@ -0,0 +1,47 @@
+.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.41.1.
+.TH RTDSERVER "1" "March 2009" "RTDSERVER" "User Commands"
+.SH NAME
+rtdServer - image event dispatcher for RTD
+.SH SYNOPSIS
+.B rtdServer
+\fI[\-v] [\-p] [\-s]\fR
+.SH DESCRIPTION
+rtdServer is the process that manages the image event mechanism.
+Clients register to the rtdServer via the rtdInitImageEvt call.
+When a client attaches to a camera source an incoming image event
+will be forwarded to this client. Several clients can attach to the
+same camera source as the multicasting of event notification is
+supported by the rtdServer.
+Image events received from image sources where no clients are attached
+are simply discarded. Clients can also attach to image sources
+that not have registered yet as the rtdServer supports a independence
+between image event producer and image event consumer.
+
+Furthermore rtdServer contains a simulator part that can be used
+to simulate the generation of image events. This feature is reserved
+for testing purposes only. Similarly, it also contains a performance
+test facility, in which several areas of shared memory are sent to
+a client Rtd in quick succession, and measurements are taken on
+certain performance parameters (see RtdPerformanceTool(3/n).
+
+The rtdServer also implements semaphore locking of shared memory, to
+avoid the possibility of the RTD client reading the shared memory
+at the same time as the CCD writes (this is known as "image jitter").
+The server program expects the CCD software to set a semaphore against
+any shared memory that has been written to (effectively to lock it).
+The server will then increment this semaphore by the number of RTD
+clients less one. If semaphores are not implemented in the incoming
+image event, no action is taken. The overall locking scheme is discussed
+in more detail in rtdSem(1). Semaphore locking is implemented in the
+simulator facility.
+.TP
+\fB\-v\fR
+verbose mode
+.TP
+\fB\-p\fR
+port number, default 5555. Set with RTD_SERVER_PORT
+.TP
+\fB\-t\fR
+delay between image events in msec (default 5)
+.SH "SEE ALSO"
+rtd(1)
diff --git a/debian/skycat.man b/debian/skycat.man
new file mode 100644
index 0000000..c08bd0d
--- /dev/null
+++ b/debian/skycat.man
@@ -0,0 +1,279 @@
+.TH SKYCAT "1" "March 2009" "SKYCAT" "User Commands"
+.SH NAME
+skycat - A tool for displaying astronomical images and catalogs
+
+.SH SYNOPSIS
+.B skycat 
+\fIfilename \-option value ...\fR
+
+.SH DESCRIPTION
+The ESO Skycat tool combines the image display capabilities of the RTD
+(Real-Time Display) with a set of classes for accessing astronomical
+catalogs locally and over the network using HTTP. The tool allows you
+to view FITS images from files or from the Digitized Sky Survey (DSS).
+
+.SH OPTIONS
+.TP
+\fB\-file filename\fR
+Specify a FITS file to display. '\-' means read the file from
+the standard input.  The '\-file' part is optional, so you can
+also simply specify a file name. Image compression and
+decompression is done automatically, based on the file name
+suffix: .gzfits or .gfits for GZIP compression, .hfits for
+H-compress, and .cfits for UNIX compression.
+.TP
+\fB\-cat bool\fR
+If bool is 1, include 'Data-Servers' menu in the menubar (This
+is the default). The 'Data-Servers' menu gives you access to
+the ESO Archive extensions for browsing astronomical catalogs,
+plotting objects in the image window and getting images over
+the network from the image servers, such as the Digitized Sky
+server.
+.TP
+\fB\-rtd bool\fR
+If bool is 1, include the Real-Time menu in the menubar
+(default is 0). The Real-Time menu gives you access to the VLT
+Real-Time Display features, such as camera control and rapid
+frames. To use these features, the rtdServer daemon must be
+running on the local host. A client application, linked with
+the Rtd image event library can then send images via shared
+memory to be displayed in rapid succession. 
+.TP
+\fB\-float_panel bool\fR
+If the option value is 1, the skycat info panel is put in a
+separate popup window, leaving more space for the image window
+(The default is off).
+.TP
+\fB\-panel_layout <saoimage | reverse | default>\fR
+With this option you can change the order of the zoom and pan
+windows in the layout. The default layout is: zoom window on
+the left, info panel in the center and pan window right. If
+"\-panel_layout saoimage" is specified, a layout similar to
+saoimage is used (info panel, pan window, zoom window). If
+"\-panel_layout reverse" is specified, the order of the windows
+is the reverse of the default.
+.TP
+\fB\-remote bool\fR
+If "\-remote 1" is specified and a skycat process is already
+running, the existing skycat process is sent a message and
+asked to open a new window and the new skycat process exits
+immediately. This has the advantage of sharing the image
+colormap and using fewer system resources, however it depends
+on being able to use the Tcl send mechanism. For security
+reasons, Tcl send will not work if you are using "xhost" based
+X security. You need to use X-auth security. See the "Tcl/Tk
+Tools" book from O'Reilly for more on this topic.
+.TP
+\fB\-min_scale n\fR
+.TP
+\fB\-max_scale n\fR
+Specify the min and max scale values for the Magnification
+menu.  Negative values shrink the image, positive values zoom
+in closer. The default values are \-10 and 20.
+.TP
+\fB-port portnum\fR
+Specify a port number to use for the remote RTD socket
+interface. See the Rtd User's Guide for details on this socket
+based interface. By default, a port number is chosen
+automatically and written to the file ~/.rtd-remote.
+.TP
+\fB\-disp_image_icon bool\fR
+If bool is 1 (default), display a miniature version of the
+image in the tool's icon window.
+.TP
+\fB\-default_cmap <cmap>\fR
+Specify the default colormap. This should be one of the names
+listed in the 'Colors' popup window (default is 'real'). 
+.TP
+\fB\-default_itt <itt>\fR
+Specify the default intensity transfer table. This should be
+one of the names listed in the 'Colors' popup window (default
+is 'ramp').
+.TP
+\fB\-colorramp_height <pixels>\fR
+This option can be used to change the height of color bar (the
+widget at the bottom of the screen displaying the image
+colors).
+.TP
+\fB\-with_colorramp bool\fR
+If bool is true, display the color bar (default).
+.TP
+\fB\-with_zoom_window bool\fR
+If bool is true, display the zoom window (default).
+.TP
+\fB\-with_pan_window bool \fR
+If bool is true, display the pan window (default).
+.TP
+\fB\-dozoom bool\fR
+If bool is true, turn the zoom window on automatically
+(default).
+
+.SH MENU ITEMS
+.SS File menu
+.TP
+\fBOpen...\fR
+Open and display a (FITS) image file.
+.TP
+\fBReopen...\fR
+Reload the image display after the image has changed
+on disk.
+.TP
+\fBSave as...\fR
+Save the current image to a file.
+.TP
+\fBSave region as...\fR
+Save a section of the current image to a file.
+.TP
+\fBPrint...\fR
+Print the current image to a file or printer.
+.TP
+\fBClear\fR
+Clear the image display.
+.TP
+\fBNew Window\fR
+Display up a new main window.
+.TP
+\fBClose\fR
+Close the main window and exit if there are no more
+windows.
+.TP
+\fBExit\fR
+Exit the application.
+
+.SS View menu
+.TP
+\fBColors...\fR
+Display a window for manipulating the image colormap.
+.TP
+\fBCut Levels...\fR
+Display a window for manipulating the image cut levels.
+.TP
+\fBCuts...\fR
+Display a graph of pixel values along a line drawn
+interactively over the image.
+.TP
+\fBPick Object...\fR
+Select an object or star in the image and display
+statistics.
+.TP
+\fBFits Header...\fR
+Display the FITS header for the current image.
+.TP
+\fBPixel Table...\fR
+Display a table of pixel values surrounding the mouse
+cursor.
+.TP
+\fBMagnification\fR
+Set the magnification factor of the image display.
+.TP
+\fBHide Control Panel\fR
+Toggle the visibility of the upper control panel
+.TP
+\fBHide Popup Windows\fR
+Toggle the visibility of the popup windows.
+
+.SS Graphics menu
+.TP
+\fBToolbox\fR
+Display the line graphics toolbox.
+.TP
+\fBMode =>\fR
+Select the drawing mode.
+.TP
+\fBWidth =>\fR
+Set the line width for drawing.
+.TP
+\fBArrow =>\fR
+Select the arrow mode for lines.
+.TP
+\fBArrorShape =>\fR
+Select the arrow shape for lines.
+.TP
+\fBFill =>\fR
+Select the fill color for drawing.
+.TP
+\fBOutline =>\fR
+Select the outline color for drawing.
+.TP
+\fBStipple =>\fR
+Select the stipple pattern for filling objects.
+.TP
+\fBFont =>\fR
+Select the font to use for labels.
+.TP
+\fBSmooth =>\fR
+Set the smooth option for drawing polygons
+
+.TP
+\fBClear =>\fR
+Delete graphic objects.
+.TP
+\fBDelete =>\fR
+Delete selected graphic objects.
+.TP
+\fBHide Graphics\fR
+Toggle the visibility of the image line graphics
+
+.SS Data-Servers
+.TP
+\fBCatalogs =>\fR
+Select a catalog from the menu.
+.TP
+\fBImage Servers =>\fR
+Select an image server from the menu.
+.TP
+\fBArchives =>\fR
+Select an archive from the menu.
+.TP
+\fBLocal Catalogs =>\fR
+Select a local catalog from the menu.
+
+.SS Real-time menu (displayed when -rtd 1 is specified)
+.TP
+\fBAttach Camera\fR
+Attach the real-time camera - start receiving images.
+.TP
+\fBDetach Camera\fR
+Detach the real-time camera - stop receiving images.
+.TP
+\fBSet Camera...\fR
+Set the real-time camera name.
+.TP
+\fBRapid Frame	\fR
+Create a rapid frame by interactively drawing a
+rectangle on the image.
+
+.SS Help menu
+.TP
+\fBAbout Skycat...\fR
+Display a window with information about this Skycat
+version.
+.TP
+\fBHelp...\fR
+Display information about Skycat in netscape (if
+netscape is available).
+
+.SH ENVIRONMENT VARIABLES
+.TP 
+\fB$SKYCAT_CONFIG \fR
+If set, this is used as the URL to access the skycat
+configuration file, which contains the list of available
+catalogs and how to query them. By default, the configuration
+file is also searched for in $HOME/.skycat/skycat.cfg, and if
+that is not found, in the ESO default URL:
+http://archive.eso.org/skycat/skycat2.0.cfg.
+.TP
+\fB$SKYCAT_PLUGIN\fR
+If set, this variable should be a colon separated list of
+files or directories containing skycat plugins. A skycat
+plugin is a Tcl script that defines a Tcl proc to be called
+for each instance of the main window. The script is sourced
+before any windows are created and can also load shared
+libraries dynamically to add new features.  See the Skycat
+User's Guide (ftp://ftp.archive.eso.org/pub/skycat/docs) for
+more information.
+.SH FILES
+http://archive.eso.org/skycat/skycat2.0.cfg - default 
+configuration file.
+.SH SEE ALSO
+SkyCat(n), Skycat(3), rtd(1), RtdImage(3), AstroCat(n)

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/skycat.git

