home *** CD-ROM | disk | FTP | other *** search
/ Garbo / Garbo.cdr / pc / source / star.lzh / star.22 < prev    next >
Encoding:
Text File  |  1990-04-06  |  33.7 KB  |  926 lines

  1.  
  2. #! /bin/sh
  3. # This is a shell archive.  Remove anything before this line, then unpack
  4. # it by saving it into a file and typing "sh file".  To overwrite existing
  5. # files, type "sh file -c".  You can also feed this as standard input via
  6. # unshar, or by typing "sh <file", e.g..  If this archive is complete, you
  7. # will see the following message at the end:
  8. #        "End of archive 22 (of 32)."
  9. # Contents:  doc/as.ms.ab
  10. PATH=/bin:/usr/bin:/usr/ucb ; export PATH
  11. if test -f 'doc/as.ms.ab' -a "${1}" != "-c" ; then 
  12.   echo shar: Will not clobber existing file \"'doc/as.ms.ab'\"
  13. else
  14. echo shar: Extracting \"'doc/as.ms.ab'\" \(32244 characters\)
  15. sed "s/^X//" >'doc/as.ms.ab' <<'END_OF_FILE'
  16. XCurrently defined command line arguments are described below.
  17. XAdditional flag interpretation may be done by the device driver:
  18. Xunidentified flags are passed to a driver-specific function which
  19. Xattempts to interpret the flag. All others are undefined, and produce a
  20. Xusage message and error exit.
  21. X.PP
  22. X.nf
  23. X.br
  24. X   
  25. XFlag    Additional argument type(s)   Mnemonic
  26. X-r    float               Right ascension
  27. X-d    float               Declination
  28. X-s    float               Scale
  29. X-m    float               Magnitude limit
  30. X-l    float               name Label magnitude limit
  31. X-g    float               Greek label magnitude limit
  32. X-p    [string]           Polar,
  33. X                   or Projection = string
  34. X                   Possible values ``sansons'',
  35. X                   ``stereographic'',
  36. X                   ``orthographic'',
  37. X                   ``gnomonic'', ``rectangular''.
  38. X-b    --none--           Big map: full page map
  39. X-i    --none--           Invert: flip map top to bottom
  40. X-t    string               Title
  41. X-y    string               Yale.star: star data file
  42. X-h    string               Harvard index.indx index file
  43. X-n    string               Neb.star: nebula data file
  44. X-w    string               Wanderers: planet.star planet data file
  45. X-f    string               File: user file
  46. X-c    string [string]           Constellation: a three or four character
  47. X                   mnemonic followed by an optional file name;
  48. X                   the file is searched for an entry
  49. X                   corresponding to that mnemonic: the entry
  50. X                   specifies the RA DEC Scale and Title.
  51. X-v    float float           Variable finder: labels stars with their
  52. X                   magnitudes if they are within
  53. X                   arg2 mags. of arg1
  54. X-x    float float [float float]  X grid: grid in RA and DEC,
  55. X                   spacing arg1 and arg2, origin at arg3 arg4
  56. X-e    string               Extra: chart control file.
  57. X-u    --none--           User input.  Allow keyboard-based user input
  58. X-a    string               Additional Argument string:
  59. X                   passed to driver for additional control.
  60. X.fi
  61. X.PP
  62. X.NH 3
  63. XControl\ and\ Specification\ Files
  64. X.br
  65. X.PP
  66. XThe controlling variables of the chart are set by default at compile
  67. Xtime, and many may be overridden by command line arguments.  However,
  68. Xmore control is afforded by \f(CW\`.starrc\'\fR and \f(CW\`-e \fIextra\fR\'\fR
  69. Xfiles.  The starchart programs attempt to read an initialization file,
  70. Xwhose name is set at compile time (default \f(CW\`./.starrc\'\fR).
  71. XAdditional such files may be read through the \f(CW\`-e\'\fR commandline
  72. Xargument.  The file contains lines of the form \f(CW\`\fIvariable\fR
  73. X\&\fIvalue\fR\'\fR or \f(CW\`\fIvariable\fR=\fIvalue\fR\'\fR, with comments
  74. Xbeginning with \f(CW\`#\'\fR ignored.  The variables and their values are
  75. Xgiven below.  These definitions reset the values of program variables,
  76. Xoverriding their current value.  These may in turn be overridden by
  77. Xlater command line arguments or additional \f(CW\`.starrc\'\fR files
  78. Xspecified with \f(CW\`-e\'\fR.  Any variables not understood by the main
  79. Xprogram are passed to a driver specific function which may interpret it.
  80. X.PP
  81. X.nf
  82. X.br
  83. X   
  84. XVariable        Value type(s)     comment
  85. Xra            float      # same as -r
  86. Xdec            float      # same as -d
  87. Xscale            float      # same as -s
  88. Xtitle            string      # same as -t
  89. Xfindconst        string      # same as first argument of -c
  90. Xconstfile        string      # same as second argument of -c
  91. Xnamelim            float      # same as -l
  92. Xlbllim            float      # same as -l
  93. Xmaglim            float      # same as -m
  94. Xgklim            float      # same as -g
  95. Xstarfile        string      # same as -y
  96. Xindexfile        string      # same as -h
  97. Xnebfile            string      # same as -n
  98. Xplanetfile        string      # same as -w
  99. Xuserfile        string      # same as -f
  100. Xmapfile            string string # set mapfile array in main routines:
  101. X                  #       sets elements in order
  102. X                  #       overrides previous settings
  103. X                  #    overrides default yale.star, etc.
  104. X                  #    second arg is type of file
  105. X                  #    as specified in index.indx
  106. Xboundfile        string      # sets file for "boundaries" layer
  107. Xpatternfile        string      # sets file for "patterns" layer
  108. Xconstlnamefile        string      # sets file for "constlnames" layer
  109. Xlayers            string      # same as all_layer:
  110. Xall_layer        string      # sets array of layers in main routines:
  111. X                  #     sets elements in order
  112. X                  #     overrides previous settings
  113. X                  # possible values :
  114. X                  # "outline" "ra_grid" "dec_grid" "ecliptic"
  115. X                  # "boundaries" "patterns" "constlnames"
  116. X                  # "allfiles" "allglyphs" "allnames"
  117. X                  # "allmaglbls" "allvectors" "allareas"
  118. X                  # "legends"
  119. Xpolarmode        logical      # same as -p if logical is nonzero or is TRUE
  120. Xbigflag            logical      # same as -b if logical is nonzero or is TRUE
  121. Xprojection_mode        string      # set projection mode
  122. X                  # may be "sansons", "stereographic"
  123. X                  # "orthographic", "gnomonic" or "rectangular"
  124. Xinvert            logical      # same as -i if logical is nonzero or is TRUE
  125. Xprecess_to          float      # Precess to equinox and ecliptic of year.
  126. Xchart_type        string      # set chart type: "fullpage" or "threepart"
  127. X                  # "threepart" is default: Large window,
  128. X                  # thumbnail, and legend
  129. X                  # "fullpage'' is same as -b flag
  130. Xvrange            float float      # same as -v
  131. Xvmags            float float      # set magnitude labeling maximum
  132. X                  # and minimum magnitudes
  133. Xgrid            float float [float float]
  134. X                  # same as -x
  135. Xnogrid            logical      # turn off display of all grids
  136. Xnogrid_ra        logical      # turn off display of RA grid
  137. Xnogrid_dec        logical      # turn off display of DEC grid
  138. Xnomaglbls        logical      # turn off display of magnitude labels
  139. Xdrivercontrol        string      # same as -a flag
  140. Xdriver_control        string      # same as -a flag
  141. Xadditional        string      # same as -a flag
  142. X
  143. XFor interactive control, the following commands are also active:
  144. X
  145. Xexit            --none--      # Exit the program
  146. Xquit            --none--      # Exit the program
  147. Xend_input        --none--      # End input, display chart
  148. Xdone_input        --none--      # End input, display chart
  149. Xdone            --none--      # End input, display chart
  150. Xdraw            --none--      # End input, display chart
  151. Xhelp            --none--      # Give help
  152. X?            --none--      # Give help
  153. Xshow            --none--      # Show value of variables
  154. Xwrite_rc_file        string      # Write current state to .starrc file
  155. Xwrite_mapwin_file   string      # Write detailed specification of
  156. X                  # chart to given filename
  157. Xread_mapwin_file    string      # Read detailed specification of
  158. X                  # chart from given filename
  159. X.fi
  160. X.PP
  161. X.PP
  162. X.PP
  163. X.PP
  164. X.PP
  165. X.NH 3
  166. XInteractive\ Controls
  167. X.br
  168. X.PP
  169. XThe \f(CW\`-u\'\fR option activates interactive mode, where the same commands
  170. Xas in the \f(CW\`.starrc\'\fR file may be typed to control the program
  171. Xoptions.  In addition, \f(CW\`end_input\'\fR ends interactive input and draws
  172. Xthe chart.  After the chart is drawn, control returns to the keyboard.
  173. XThe \f(CW\`quit\'\fR command exits the program.  The command \f(CW\`show\'\fR
  174. Xshows the current state of the control variables.  The command
  175. X\&\f(CW\`help\'\fR may be used to get a brief description of the commands and
  176. Xcontrols available.
  177. X.PP
  178. XSome, especially window based, versions will allow the user final
  179. Xcontrol over each map of the chart.  The chart is specified by an
  180. Xarray of large \fBC\fR structures, one for each map on the page.  The
  181. X\&\f(CW\`mapwin\'\fR file contains the values in this structure.  Advanced
  182. Xinteractive versions of starchart, such as \fBstarXaw\fR, allow the
  183. Xcomponents of the structures to be edited individually, providing full
  184. Xaccess to the flexible controls of the program.
  185. X.PP
  186. XThe sequence of control of the program is:
  187. X.PP
  188. X1) read the \f(CW\`./.starrc\'\fR file.
  189. X.PP
  190. X2) process the command line: options are processed in order, later
  191. Xarguments may override earlier arguments, additional \f(CW\`.starrc\'\fR
  192. Xformat files are read as they are encountered in \f(CW\`-e\'\fR options.
  193. XHowever, if the file specified in the \f(CW\`-e\'\fR option is in \f(CW\`mapwin\'\fR
  194. Xformat, it is read later.  After the command line is processed, if the
  195. X\&\f(CW\`-u\'\fR option is active, keyboard interaction is performed.  Next,
  196. Xany \f(CW\`mapwin\'\fR format files are read.  If there is more interaction
  197. Xavailable (e.g. as in \fBstarXaw\fR), the details of the chart may now be
  198. Xcontrolled.  If a \f(CW\`mapwin\'\fR file is to be written, it is written now.
  199. XThen the chart is drawn to specification.  Finally, after the chart is
  200. Xdrawn, the program returns to the first interaction (i.e. returns to
  201. Xthe point after the command line has been processed).
  202. X.PP
  203. XOne more form of interaction is available on some systems:  A mouse or
  204. Xother pointing device may be used to either select points on a map and
  205. Xthe coordinates of that point are displayed, or the databases may be
  206. Xsearched for objects near the selected point and the database entries
  207. Xfor the objects found are displayed.
  208. X.PP
  209. X.NH 2
  210. XStandard\ Data\ Files
  211. X.br
  212. X.PP
  213. XAll are in equinox 2000.0 coordinates, and should also be in epoch
  214. X2000.0.
  215. X.PP
  216. X.IP \f(CW\`yale.star\'\fR\ 
  217. Xstellar information (mandatory)
  218. X.IP
  219. X.IP \f(CW\`neb.star\'\fR\ 
  220. Xnebulae (optional)
  221. X.IP
  222. X.IP \f(CW\`planet.star\'\fR\ 
  223. Xplanets (optional)
  224. X.IP
  225. X.IP \f(CW\`boundaries.star\'\fR\ 
  226. Xconstellation boundaries (optional)
  227. X.IP
  228. X.IP \f(CW\`cnames.star\'\fR\ 
  229. Xconstellation names (optional)
  230. X.IP
  231. X.IP \f(CW\`patterns.star\'\fR\ 
  232. Xconstellation patterns (optional)
  233. X.IP
  234. X.IP \f(CW\`index.indx\'\fR\ 
  235. Xindex file for additional star files (optional)
  236. X.IP
  237. X.IP \f(CW\`con.locs\'\fR\ 
  238. Xdefault mnemonic locations
  239. X.IP
  240. X.PP
  241. X.NH 2
  242. XParticular\ Starchart\ Programs
  243. X.br
  244. X.PP
  245. XSome starchart programs have coadditional driver-specific controls
  246. Xwhich are accessed throught the \f(CW\`-a\'\fR command line option, or the
  247. X\&\f(CW\`additional\'\fR (= \f(CW\`driver_control\'\fR) variable.
  248. X.PP
  249. XThese programs and other versions of starchart with special needs are
  250. Xdocumented in this section.
  251. X.PP
  252. X.PP
  253. X.NH 3
  254. X\&\fBstarX11\fR
  255. X.br
  256. X.PP
  257. X\&\fBstarX11\fR is the X11 version of starchart.  It has the following
  258. Xspecial arguments which are accessed through \f(CW\`-a\'\fR, e.g.
  259. X.br
  260. X\&\f(CW\`-a p\'\fR.
  261. X.PP
  262. X.IP \f(CW\`p\'\fR\ 
  263. XPostScript preview: use screen size and shape to approximate coverage of
  264. X\&\fBstarpost\fR chart. 
  265. X.IP \f(CW\`l\'\fR\ 
  266. XPostScript landscape preview: use screen size and shape to approximate
  267. Xcoverage of \fBstarpost\fR landscape format chart. 
  268. X.IP \f(CW\`h\'\fR\ 
  269. Xhide: display is generated invisibly, which may save time. 
  270. X.IP \f(CW\`b\'\fR\ 
  271. Xbackup: use backup pixmap, allows window to be hidden and redrawn. 
  272. X.IP \f(CW\`m\'\fR\ 
  273. Xmonochrome: prevents use of color on displays otherwise capable of it. 
  274. X.PP
  275. XUsage example:
  276. X.br
  277. X\&\f(CW\`starX11 -c ori -g 5 -a p\'\fR.
  278. X.PP
  279. X.NH 3
  280. X\&\fBstarXaw\fR
  281. X.br
  282. X.PP
  283. X\&\fBstarXaw\fR is the X11 version of starchart with interactive control
  284. Xusing Athena Widgets.  In addition to the controls for \fBstarX11\fR,
  285. Xit has the following special arguments which are accessed through
  286. X\&\f(CW\`-a\'\fR, e.g. 
  287. X.br
  288. X\&\f(CW\`-a "t -geometry -0-0"\'\fR.
  289. X.PP
  290. X.IP \f(CW\`t\'\fR\ 
  291. X" toolkit_args" for access to the standard X toolkit controls, such as
  292. Xfor geometry, fonts, etc. 
  293. X.PP
  294. XUsage example:
  295. X.br
  296. X\&\f(CW\`starXaw -c sgr -a p -a "t -geometry -0-0 -bg red"\'\fR.
  297. X.PP
  298. X.NH 3
  299. X\&\fBstarpost\fR
  300. X.br
  301. X.PP
  302. X\&\fBstarpost\fR is the PostScript version of starchart.  It has the
  303. Xfollowing special arguments which are accessed through \f(CW\`-a\'\fR, e.g.
  304. X.br
  305. X\&\f(CW\`-a "m9 8 7 6 5 4 3.5 2.5 2 1.5 1 0.5"\'\fR. 
  306. X.PP
  307. X.IP \f(CW\`n\'\fR\ 
  308. Xnotebook: The chart is shifted to the right on the page, and the
  309. X``thumbnail'' map is replaced with prompts and space for recording
  310. Xobserving conditions.  The rest of the argument string is taken to be a
  311. Xlist of floating point numbers separated by `:' or ` '.  These are taken
  312. Xto be the radii in degrees of fields of view of the instrument or
  313. Xfinder.  Circles with these radii are drawn, centered on the center of
  314. Xthe chart. 
  315. X.IP \f(CW\`m\'\fR\ 
  316. Xmagnitude: 0.1 magnitude quanta are to be used (the default is 1.0
  317. Xmagnitude, e.g. a 4.6 magnitude star is represented by the same symbol
  318. Xas a star of magnitude 5.4).  The rest of the argument string is taken
  319. Xto be a list of floating point numbers separated by `:' or ` '.  These
  320. Xare taken to be the radii of the symbols for stars of magnitude -1, 0,
  321. X1, 2, 3 etc. The sizes of symbols for stars with magnitudes between
  322. Xthese magnitudes are determined by linear interpolation.  Note that the
  323. Xlast value given is the value assigned to all magnitudes fainter than
  324. Xthat magnitude.  Current default sizes are "9 8 7 6 5 4 3.25 2.5 2 1.5 1
  325. X0.5". 
  326. X.IP \f(CW\`s\'\fR\ 
  327. Xsize: this argument provides an alternative way of specifying
  328. Xmagnitude symbol sizes, using a formula proposed by Andrew Young in
  329. XSky and Telescope, March 1990, p. 311, D = D0 * 10^(k*(v0 - v)).
  330. XHe proposes a k of between 0.07 and 0.16, with 0.11 as probably the
  331. Xbest.  If \f(CW\`s\'\fR uses 0.1 magnitude quanta as does \f(CW\`m\'\fR.  The
  332. Xdefault values for \fID0\fR, \fIv0\fR, and \fIk\fR are 0.5 (points),
  333. Xthe limiting magnitude of the first main map, and 0.11, respectively.
  334. XThese may be altered with the optional arguments to \f(CW\`s\'\fR, which set
  335. X\&\fID0\fR, \fIv0\fR and \fIk\fR in that order, e.g. \f(CW\`s 0.7 6.6\'\fR sets
  336. X\&\fID0\fR to 0.7 point, and \fIv0\fR to magnitude 6.6 so that a magnitude
  337. X6.6 star will be printed as 0.7 point in diameter, and \fIk\fR will
  338. Xremain 0.11.  \f(CW\`s 0.7 6.6 0.07\'\fR will set \fID0\fR and \fIv0\fR as
  339. Xabove, and also set \fIk\fR to 0.07. 
  340. X.IP \f(CW\`f\'\fR\ 
  341. X\&\f(CW\`f \fIfile\fR\'\fR may be used to specify an output file, otherwise the
  342. XPostScript produced is sent to the standard output. 
  343. X.IP \f(CW\`c\'\fR\ 
  344. Xmay be used to produce color postscript output. 
  345. X.IP \f(CW\`l\'\fR\ 
  346. Xmay be used to specify landscape mode (as opposed to the default
  347. Xportrait orientation).  Landscape mode can only used with a
  348. Xfullpage map.  
  349. X.PP
  350. XSince the resolution of PostScript is much higher than other common
  351. Xdevices, \f(CW\`mapwin\'\fR files must be edited when transferred between
  352. Xstarpost and other drivers.  The controls for window \f(CW\`width\'\fR,
  353. X\&\f(CW\`height\'\fR, \f(CW\`x_offset\'\fR and \f(CW\`y_offset\'\fR must be changed. 
  354. X.PP
  355. XThe \f(CW\`-a p\'\fR or \f(CW\`-a l\'\fR option used with \fBstarX11\fR or
  356. X\&\fBstarXaw\fR can be used to produce a \f(CW\`mapwin\'\fR file which can be
  357. Xconverted for use in \fBstarpost\fR through an \fBawk\fR script named
  358. X\&\fBpostconv.awk\fR, provided with the source to this program. 
  359. X.PP
  360. XUsage example:
  361. X.br
  362. X\&\f(CW\`starpost -a "n 6:1.5:.5" -a "m9 8 7 6 5 4 3.5 2.5 2 1.5 1 0.5" -a "f orion.PS" -c ori -g 5\'\fR.
  363. X.PP
  364. X.NH 3
  365. X\&\fBstartool\fR
  366. X.br
  367. X.PP
  368. X\&\fBstartool\fR uses the \fBtooltool\fR program, not included in the
  369. Xstarchart distribution, to provide an interface to \fBstarsunv\fR.
  370. X\&\fBttooltool\fR is available from your local Sun sources archive.
  371. X.PP
  372. X.NH 2
  373. XWriting\ a\ New\ Version\ for\ a\ New\ Device
  374. X.br
  375. X.NH 3
  376. XOrganization
  377. X.br
  378. X.PP
  379. XThere are several layers of functions in starchart.  The top level is in
  380. X\&\f(CW\`starmain.c\'\fR, \f(CW\`starm2.c\'\fR, and \f(CW\`readfile.c\'\fR.  It is (I
  381. Xhope) general enough to enable any additions to be made by users in the
  382. Xform of modified drivers, leaving these files stable.  \f(CW\`starmain.c\'\fR
  383. Xand \f(CW\`starm2.c\'\fR are in charge of the user interface and file
  384. Xreading, with \f(CW\`readfile.c\'\fR.  Generally, this top level controls
  385. X\&\fIwhat\fR is to be drawn, and \fIwhere\fR it appears.  The device
  386. Xspecific section controls \fIhow\fR it appears.
  387. X.PP
  388. XInformation is passed to the drivers via externs and function
  389. Xparameters.  The externs are for runtime values, the function parameters
  390. Xare for values taken from the data files.  Information is passed from
  391. Xthe driver to the starchart.c routines via externs.
  392. X.PP
  393. XThere are three layers of functions, in several source files.  The top
  394. Xlevel functions are in \f(CW\`starmain.c\'\fR and \f(CW\`starm2.c\'\fR.  You
  395. Xshould not have to change anything in this file, except perhaps #defines
  396. Xfor default file names and file types, and these may also be set in the
  397. XMakefile.
  398. X.PP
  399. XThe \f(CW\`starcust.c\'\fR file contains customizing functions, including functions
  400. Xto define additional command line flags, which may apply to several
  401. Xdrivers.
  402. X.PP
  403. XThe \f(CW\`starXXXX.c\'\fR or \f(CW\`starimages.c\'\fR + \f(CW\`starXXXX.c\'\fR files
  404. Xdefine the more device dependent functions.  There is one function,
  405. Xcalled \f(CW\`drawobj\'\fR, which is the interface between the top level
  406. Xfunctions and the device for drawing the stars, planets, and other
  407. Xobjects read from a database file.  In addition, standard functions to
  408. Xopen and close the device, draw a line, move without drawing, etc. are
  409. Xrequired.  These may then call the lowest level device dependent
  410. Xfunctions.  The \f(CW\`starimages.c\'\fR file provides a standard definition
  411. Xfor \fBdrawobj\fR and supporting functions for bitmapped devices; the
  412. Xdevice dependent code remaining (e.g. line drawing), is in the file
  413. X\&\f(CW\`starXXXX.c\'\fR.
  414. X.PP
  415. XUser input functions also may be defined in \f(CW\`starXXXX.c\'\fR.
  416. X.PP
  417. XThe layer currently being drawn and/or the subroutine currently active
  418. Xis passed to the driver in an extern.  This allows the driver to for
  419. Xexample draw vectors differently for the constellation boundaries.
  420. XAdditionally, each window has a map type field which is for efficiency
  421. Xalso passed as an extern, which may be used by the driver to for example
  422. Xdraw certain layers differently in certain windows.
  423. X.PP
  424. XThe source to other drivers, especially \fBstarXaw\fR and
  425. X\&\fBstarpost\fR, should be a valuable reference to developing new
  426. Xdrivers.
  427. X.PP
  428. X.NH 3
  429. XCustomization
  430. X.br
  431. X.PP
  432. XFor the drivers distributed, there are many \f(CW\`#defines\'\fR and global
  433. Xvariables whose values may be altered to suit your tastes and your
  434. Xparticular piece of hardware.  Default file names are \f(CW\`#defined\'\fR in
  435. Xthe code, and may also be set in the Makefile.
  436. X.PP
  437. XIt is easy to write a driver for other devices, based on the drivers and
  438. Xthe driver skeleton provided.
  439. X.PP
  440. XMore extensive customization is possible through modifying the driver
  441. Xfunctions to take fullest advantage of the device you are using.  It is
  442. Xalso possible to add controls accessed through the \f(CW\`-a\'\fR command
  443. Xline option and the \f(CW\`additional\'\fR (= \f(CW\`driver_control\'\fR) variables.
  444. X.PP
  445. XPlease try to send me (ccount) a note before writing any new drivers, so
  446. XI can let you know if a driver for that device is in the works.  Any
  447. Ximprovements to drivers should be sent to me or the author (if they are
  448. Xnot the same), when you're sure they work and are happy with the
  449. Xchanges.
  450. X.PP
  451. XThings you define in \f(CW\`starcust.c\'\fR, if you think they are generally
  452. Xuseful, should be sent to me.  If possible, they may be incorporated in
  453. Xfuture releases.
  454. X.PP
  455. XImprovements to top level routines should be made with great caution.
  456. XSuch changes will make it harder for you to use future refinements.  If
  457. Xyou're sure you're change (a) works and (b) is better/stronger/faster,
  458. Xplease send it to me.
  459. X.PP
  460. XDo report any bugs/problems.
  461. X.PP
  462. X.bp
  463. X.NH
  464. XThe\ Data\ Files\ and\ Their\ Formats
  465. X.br
  466. X.PP
  467. XThis section discusses file formats used by the programs.
  468. X.PP
  469. X.PP
  470. X.NH 2
  471. XContents\ of\ Data\ Files
  472. X.br
  473. X.PP
  474. XEach line of file contains:
  475. X.IP \fIra,\ dec,\ mag\fR\ 
  476. XRequired.  Right ascension, Declination, and magnitude (V or visual).  6
  477. Xchars for RA, one for sign of DEC, 4 for DEC, 3 for mag. 
  478. X.IP
  479. X.IP \fIobject\ type\fR\ 
  480. XDefines what the object is: star, galaxy, cluster, nebula, planet,
  481. Xother, unknown, vector, area, comment, or invisible, with subtypes for
  482. Xeach (Two chars).  Defaults to type star subtype single. 
  483. X.IP
  484. X.IP \fIspectral\ class\ or\ color\fR\ 
  485. XDefines the color of the object, as spectral class for stars or directly
  486. Xfor other objects (Two chars). 
  487. X.IP
  488. X.IP \fIletter\ or\ flamsteed\ number\ or\ size\fR\ 
  489. XDefines either the Bayer letter or Flamsteed number of a star, or the
  490. Xsize of an extended object encoded in two chars. 
  491. X.IP
  492. X.IP \fIconstellation\fR\ 
  493. XThe constellation field contains the IAU designation of the
  494. Xconstellation the object is in (three chars). 
  495. X.IP
  496. X.IP \fIname\fR\ 
  497. XName or other labeling string.  Terminated by comma. 
  498. X.IP
  499. X.IP \fIcomment\ field\fR\ 
  500. XRemainder of line after the comma which terminates the name.  This
  501. Xcomment field may be used for special information about the object, e.g.
  502. Xthe phase of the moon. 
  503. X.PP
  504. XMagnitude is encoded into three fields as follows: the first character
  505. Xmay be a \f(CW\`-\'\fR, in which case the next two characters are the magnitude
  506. Xtimes 10, e.g. \f(CW\`-16\'\fR means \f(CW\`-1.6\'\fR.  The first character is a digit,
  507. Xthe three characters are the magnitude times 100, e.g. \f(CW\`563\'\fR means
  508. X\&\f(CW\`5.63\'\fR.  Finally, if the first character is a capital letter, this is
  509. Xtaken as the base-36 value of the integral part of the magnitude, and
  510. Xthe remaining two characters are the fractional part times 100, e.g.
  511. X\&\f(CW\`B34\'\fR means \f(CW\`11.34\'\fR.
  512. X.PP
  513. XThe Bayer letter or Flamsteed numbers are applicable only to stars.  The
  514. Xfield is two characters wide.  Greek letters are a single lowercase
  515. Xletter followed by a space or a number, encoded as in the PostScript
  516. XSymbol font:
  517. X.PP
  518. X.nf
  519. X.br
  520. X  
  521. Xalpha    - a    beta    - b    gamma    - g    delta    - d
  522. Xepsilon    - e    zeta    - z    eta    - h    theta    - q
  523. Xiota    - i    kappa    - k    lambda    - l    mu    - m
  524. Xnu    - n    xi    - x    omicron - o    pi    - p
  525. Xrho    - r    sigma    - s    tau    - t    upsilon    - u
  526. Xphi    - f    chi    - c    psi    - y    omega    - w
  527. X.fi
  528. X.PP
  529. XNote that theta, xi, phi, chi, and psi have changed from the original
  530. Xdefinitions, which were @, E, 0, x, and % respectively.  Note also that
  531. Xa variant version of phi is mapped to j. 
  532. X.PP
  533. XAn uppercase letter followed by any character or two non-numeric
  534. Xcharacters is the roman letter designation for the star, e.g. \f(CW\`CY\'\fR.
  535. XTwo numbers or a space and a number is the Flamsteed number of the star.
  536. X.PP
  537. XThe size of nonstellar objects is encoded in seconds of arc in the size
  538. Xfield to two significant digits.  The second character is always a
  539. Xdecimal digit.  Sizes from 0 to 99 arc seconds are encoded as two
  540. Xdecimal digits.  For larger objects the first character is a capital
  541. Xletter, interpreted as follows, with the second character as the next
  542. Xdigit:
  543. X.PP
  544. X.nf
  545. X.br
  546. X   
  547. XFirst character        Value
  548. X0 - 9            00 - 90
  549. XA - I            100 - 900
  550. XJ - R            1000 - 9000
  551. XS - Z            10000 - 80000
  552. X.fi
  553. X.PP
  554. XExamples:
  555. X.PP
  556. X.nf
  557. X.br
  558. X   
  559. XSize field    Value
  560. X 6        6
  561. X09        9
  562. X73        73
  563. XA0        100
  564. XC3        330
  565. XD5        450
  566. XI6        960
  567. XJ2        1200
  568. XR3        9300
  569. XS6        16000
  570. XZ0        80000
  571. XZ9        89000
  572. X.fi
  573. X.PP
  574. XThe types and subtypes implemented are:
  575. X.PP
  576. X.nf
  577. X.br
  578. X   
  579. XType[0]        main type    type[1]        subtype
  580. XC        cluster
  581. X                G        globular
  582. X                O        open
  583. X                (other)     other
  584. X
  585. XG        galaxy
  586. X                a        spiral Sa
  587. X                b        spiral Sb
  588. X                c        spiral Sc
  589. X                d        spiral Sd
  590. X                p        spiral Sp
  591. X                Z        spiral S0
  592. X                s        spiral unspecified
  593. X                A        barred spiral SBa
  594. X                B        barred spiral SBb
  595. X                C        barred spiral SBc
  596. X                D        barred spiral SBd
  597. X                P        barred spiral SBp
  598. X                S        barred spiral unspecified
  599. X                0-7        elliptical E0-E7
  600. X                E        elliptical
  601. X                I        irregular I
  602. X                Q        quasar
  603. X                U        unknown
  604. X                !        peculiar
  605. X                         unspecified
  606. X                (other)     other
  607. X
  608. XN        nebula
  609. X                D        diffuse
  610. X                P        planetary
  611. X                (other)     other
  612. X
  613. XP        planet
  614. X                M        Mercury
  615. X                V        Venus
  616. X                m        Mars
  617. X                J        Jupiter
  618. X                s        Saturn
  619. X                U        Uranus
  620. X                N        Neptune
  621. X                P        Pluto
  622. X                A        Asteroid
  623. X                C        Comet
  624. X                S        Sun (Sol)
  625. X                L        Moon (Luna)
  626. X                (other)     other
  627. X
  628. XS        star
  629. X                S        single
  630. X                D        double
  631. X                V        variable
  632. X
  633. XO        other
  634. X                (any)        other object
  635. X
  636. XU        unknown
  637. X                (any)        unknown object
  638. X
  639. XV        vector
  640. X                M        moveto (begin, no line drawn)
  641. X                S        solid lineto via great circle
  642. X                D        dotted lineto via great circle
  643. X                H        hyphened (dashed) lineto g. c.
  644. X                m        moveto linear
  645. X                s        solid lineto linear
  646. X                d        dotted lineto linear
  647. X                h        hyphened lineto linear
  648. X
  649. XI        invisible
  650. X                (any)        for labels
  651. X
  652. X#        data comment
  653. X                (any)        for comment in file
  654. X
  655. XA        area
  656. X                M        moveto (begin)
  657. X                A        add great circle border segment
  658. X                F        fill region and end region
  659. X                m        moveto (begin)
  660. X                a        add linear border segment
  661. X                f        fill region and end region
  662. X.fi
  663. X.PP
  664. X.PP
  665. XThe magnitude of an object determines what information is displayed.
  666. XThree magnitude limits are defined for each file in each map window.  If
  667. Xthe magnitude is greater (dimmer) than the first limit, nothing is
  668. Xdrawn.  If the object is brighter than a second limit, the label (Bayer
  669. Xor Flamsteed) is printed (if present).  If it is brighter than the third
  670. Xlimit, the name is printed (if present; if not, the label is printed if
  671. Xpresent).  These text strings generally appear to the right of the
  672. Xobject, but the driver can change this.  Note: the label string only
  673. Xapplies to stars.
  674. X.PP
  675. XFor nonstellar objects, the label field defines the size of the object
  676. Xin arc seconds.
  677. X.PP
  678. XFor magnitudes within a range defined for the mapwindow, a magnitude
  679. Xtag, the magnitude to one decimal place as in variable star and asteroid
  680. Xfinding charts, may be displayed.  This will generally be below and to
  681. Xthe right of the object, but this is controlled by the driver.
  682. X.PP
  683. XThe symbol drawn for the object is determined by the type field.
  684. X.PP
  685. XFor devices supporting color, the spectral class or color field defines
  686. Xthe color of the object, and perhaps the associated text.  The spectral
  687. Xclass of stars is mapped to display color, and for other objects, this
  688. Xfield may contain direct color specifications, e.g. 'r3' for an object
  689. Xcolored red level 3.  All this is controlled by the device driver.
  690. XStandards for color definitions are yet to be defined.
  691. X.PP
  692. XThe constellation field is not currently used in the display.
  693. X.PP
  694. XThe comment field is also not generally used, but some drivers may use
  695. Xit to contain special information such as the phase of the moon or
  696. Xposition angle of a comet's tail.
  697. X.PP
  698. X.NH 2
  699. XData\ file\ formats
  700. X.br
  701. X.PP
  702. X.PP
  703. X.NH 3
  704. X\&\f(CW\`lineread\'\fR
  705. X.br
  706. X.PP
  707. XThis text format, called \fIlineread\fR, is the original data file format.
  708. XData for each object is on a single line, stored in character fields.
  709. XCurrently, an older variant is also supported, one which has 4
  710. Xcharacters for the magnitude and omits the color and letter/number
  711. Xfields.  Both of these formats are designated as type \fIlineread\fR,
  712. Xsince each line is read individually and these two types are easily
  713. Xdistinguished on a line by line basis.  In all formats, if a value is
  714. Xunknown, it should be spaces, or a null string in the case of the name
  715. Xand comment fields.  The RA, DEC and mag. must always be provided for an
  716. Xobject.
  717. X.PP
  718. XSince it is a text format, it may be mailed safely and be used on many
  719. Xdifferent computer architectures without change.  However, it is slow,
  720. Xand uses more file space than it ought.
  721. X.PP
  722. X.PP
  723. X.NH 3
  724. X\&\f(CW\`sif\'\fR:\ Starchart\ Interchange\ Format
  725. X.br
  726. X.PP
  727. XThe \fIsif\fR format was introduced to allow data to be exchanged as text,
  728. Xwith greater precision in the location and magnitude fields, and greater
  729. Xreadability compared to the \fIlineread\fR format.  The format is too slow
  730. Xfor use as input to the starchart programs.  A data conversion program
  731. Xis provided to convert between formats, and to precess coordinates
  732. Xduring the conversion.
  733. X.PP
  734. XEach object is represented by a single line in the file.  This line
  735. Xcontains fields each of which corresponds to a field in the
  736. X\&\fIlineread\fR format.  The fields are separated by a single character,
  737. Xusually \f(CW\`;\'\fR.  Fields may be omitted from the end of the line;
  738. Xomitted fields are assigned their default values.  Fields may be empty,
  739. Xand again are assigned their default values.  As with the other formats,
  740. Xthe RA, DEC, and mag. must be present.
  741. X.PP
  742. XThe RA may be given as a decimal hour, hour and decimal minute, or hour
  743. Xminute and decimal second.  The DEC may be given in the same format.
  744. XThe magnitude is a floating point number.
  745. X.PP
  746. XThe type, and color, fields are empty or one or two characters, as in
  747. Xthe \fIlineread\fR format.
  748. X.PP
  749. XThe label field is also the same as in the \fIlineread\fR format, and
  750. Xencodes the size of non-stellar objects in two characters.  There is a
  751. Xbit of ``magic'' in this field.  Since \f(CW\`X \'\fR or \f(CW\` X\'\fR are both
  752. Xvalid, and whitespace is normally ignored, iff this field is two
  753. Xcharacters wide, and both characters are printing characters, it is
  754. Xtaken verbatim as the label field.  That is, \f(CW\`... ; X; ...\'\fR is
  755. X\&\f(CW\` X\'\fR, while \f(CW\`... ; X ; ...\'\fR is read as one character and left
  756. Xjustified to become \f(CW\`X \'\fR. 
  757. X.PP
  758. XThe constellation field is the IAU abbreviation for the constellation
  759. Xand is always blank or three characters.
  760. X.PP
  761. XThe name and comment are two separate fields.  Commas should not be used
  762. Xin the name field, since when this name is placed in the other formats a
  763. Xcomma is used to separate the name from comments.
  764. X.PP
  765. X.NH 3
  766. XBinary\ Formats
  767. X.br
  768. X.PP
  769. XThree binary input formats are supported.  These formats provide greater
  770. Xposition and magnitude accuracy, with faster input, and varying degrees
  771. Xof storage space reduction.  The files are inherently unportable,
  772. Xhowever, and should not be exchanged between machines and operating
  773. Xsystems, or even different compilers.  The \fIsif\fR format, described
  774. Xabove, provides a general data exchange format.
  775. X.PP
  776. XThe three formats provide different storage sizes.  The most general
  777. Xformat, which contains all the data in the \fIlineread\fR format, is the
  778. X\&\fIbinfull\fR format.  A smaller format, \fIbinobj\fR stores only the
  779. XRA, DEC, mag. and object type fields, all other fields become their
  780. Xdefaults (usually spaces).  The smallest format, \fIbinstar\fR stores
  781. Xonly the RA, DEC and mag., all other fields become their defaults,
  782. Xnotably the \fIobject type\fR is \f(CW\`SS\'\fR.
  783. X.PP
  784. XThe binary formats are described as \fBC\fR structures.  How the data in
  785. Xthe structure is stored is therefore highly variable between compilers,
  786. Xoperating systems and machines.  However, most machines should be able
  787. Xto take advantage of these formats for local storage.
  788. X.PP
  789. X.NH 3
  790. XThe\ Guide\ Star\ Catalog
  791. X.br
  792. X.PP
  793. XThe Hubble Space Telescope Guide Star Catalog, available on 2 CD-ROMs,
  794. Xmay be used as a stellar database.  This format may be read by
  795. X\&\fBdataconv\fR and the starchart programs, but now written.  An index
  796. Xfile is used to specify which files on which CD-ROM should be read.
  797. X.PP
  798. X.NH 3
  799. XThe\ Index\ File\ index.indx,\ \f(CW\`indextype\'\fR
  800. X.br
  801. X.PP
  802. XThe \fIindextype\fR file is a special file format added to support larger
  803. Xdatabases of dimmer stars.  It provides an index mapping location to
  804. Xfilenames of files containing star data as above.  Each indexed file
  805. Xcovers a rectangle of sky in RA and DEC.  The areas may be different
  806. Xsizes for different files.  The area covered is given as the RA and DEC
  807. Xof the upper left and lower right corners, followed by the filename and
  808. Xa string indicating the type of the file.  This is all on one line in
  809. Xthe file.  The format is then:
  810. X.PP
  811. X.nf
  812. X.br
  813. X   
  814. Xupper left   upper left   lower right   lower right   filename   filetype
  815. XRA         DEC      RA        DEC          filename     filetype
  816. X
  817. Xe.g.
  818. X02.0         -30.0       00.0            -90.0          SAO00-90     lineread
  819. X04.0         -30.0       02.0            -90.0          SAO02-90     lineread
  820. X06.0         -30.0       04.0            -90.0          SAO04-90     lineread
  821. X08.0         -30.0       06.0            -90.0          SAO06-90     lineread
  822. X10.0         -30.0       08.0            -90.0          SAO08-90     lineread
  823. X.fi
  824. X.PP
  825. X.PP
  826. X.bp
  827. X.NH
  828. XThe\ Support\ Programs
  829. X.br
  830. X.PP
  831. XSeveral support programs are provided for use with the primary
  832. X\&\fBobserve\fR and starchart programs.
  833. X.PP
  834. X.PP
  835. X.NH 2
  836. X\&\fBdataconv\fR
  837. X.br
  838. X.PP
  839. XThis program is used to convert between file formats, especially to
  840. Xgenerate binary format files.  It can precess coordinates as desired.
  841. XRemember, input data files for starchart programs should be in 2000.0
  842. Xcoordinates.
  843. X.PP
  844. X.NH 2
  845. X\&\fBsif-to-text\fR
  846. X.br
  847. X.PP
  848. XThe \fBsif-to-text\fR or \fBsif_to_text\fR program converts sif format
  849. Xfiles to more readable text tables.
  850. X.PP
  851. X.NH 2
  852. X\&\fBtosize\fR
  853. X.br
  854. X.PP
  855. XThis program is used to encode the size of objects, for development of
  856. Xnew databases.
  857. X.PP
  858. X.bp
  859. X.NH
  860. XAcknowledgements
  861. X.br
  862. X.PP
  863. XThe previous versions of starchart were developed by Alan Paeth.
  864. X.PP
  865. XSteve Kennedy contributed to \f(CW\`starimages.c\'\fR.
  866. X.PP
  867. XRobert Tidd provided the original \f(CW\`yale.star\'\fR and the format.
  868. X.PP
  869. XDave Van't Hof provided most of the other databases (in particular boundaries,
  870. Xpatterns, and names).
  871. X.PP
  872. XMichael Campanella provided vms support.
  873. X.PP
  874. XThe Atari ST version was developed by Holger Zessel and Markus Kempf.
  875. X.PP
  876. XTom Horsley contributed the ibm PC driver.
  877. X.PP
  878. XMike Daly helped with the Macintosh version.
  879. X.PP
  880. XJoe Wang helped with the X11 version.
  881. X.PP
  882. XDean Payne provided the original code for \f(CW\`.starrc\'\fR processing.
  883. X.PP
  884. XOther contributions are from Petri Launiainen, Jyrki Yli-Nokari, Sjoerd
  885. XMullender, David Smith, Tim Pointing, and others.
  886. X.PP
  887. X.PP
  888. X.bp
  889. X.SH
  890. XProgram\ Index
  891. X.br
  892. X.PP
  893. X.PP
  894. X.bp
  895. X.SH
  896. XConcept\ Index
  897. X.br
  898. X.PP
  899. X.PP
  900. X.PP
  901. END_OF_FILE
  902. if test 32244 -ne `wc -c <'doc/as.ms.ab'`; then
  903.     echo shar: \"'doc/as.ms.ab'\" unpacked with wrong size!
  904. fi
  905. # end of 'doc/as.ms.ab'
  906. fi
  907. echo shar: End of archive 22 \(of 32\).
  908. cp /dev/null ark22isdone
  909. MISSING=""
  910. for I in 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 31 32 ; do
  911.     if test ! -f ark${I}isdone ; then
  912.     MISSING="${MISSING} ${I}"
  913.     fi
  914. done
  915. if test "${MISSING}" = "" ; then
  916.     echo You have unpacked all 32 archives.
  917.     rm -f ark[1-9]isdone ark[1-9][0-9]isdone
  918. else
  919.     echo You still need to unpack the following archives:
  920.     echo "        " ${MISSING}
  921. fi
  922. ##  End of shell archive.
  923. exit 0
  924.  
  925.  
  926.