hgs.man/*.html notation and style

Fixed-spaced symbols and strings signify names, variables and parameters relating to the computer, variable-spaced text is used in explanations (however not always in the older pages). If you are in trouble or perceive confusion, please send email to the author, hgs kanelbulle chalmers.se

  command argument 
- what appears in bold style is ready to be entered, exactly as shown, into a file or at the shell prompter. Eventually, for better visibility, a character might appear underscored.
  fixed-spaced-string
- in normal weight, entities that are supposed to exist on the machine but shouldn't be entered at a command prompter.
  mandatory
- to be replaced with characters, anything ASCII, according to the explanations. If blankspace is part of the entry there'll be mandatory single or double quotes shown in bold around the argument, e.g.   'manda tory' or   'manda tory'

  [optional] [option]
- note: the brackets are in normal weight, so the appearance of something non-empty is not mandatory. Note the emphasis on a mandatory right-bracket in an optional argument, like  [this]]  or  [var]]

- On the very right-hand side in explanatory text, often in the last line of a paragraph, the content of the bracket shows a default value or default state.
  {alt1|alt2}  {abc|def}
- mandatory specification with alternatives.
  [{abc|def}]
- optional argument with strict alternatives.

   #val
- emphasizing a numerical argument; note: the #-symbol appears in italic; it's for emphasizing that the input is numeric. Explanations will tell whether integer or floating-point numbers are possible or required
 
   <string>
- emphasizing a string argument, most often a file name.
   `a´
- in explanatory text, for emphasis on a unique symbol.
 
   colours colours colours colours
- green and purple text may appear to distinguish program output and file content, respectively. Dark-red for self-entertainment of the author, light-red for exceptions, abnormalities, and problems.


EXAMPLES:

A difficult one from tslist.html

  -TT[[s]b][{*|/}[s]f[sa]]   OBS! no blanks   OBS! quoting is required with `*´
                                                  (try `x´ instead)
             - linear expression for time record under options -i -N -J -{h|m|s}fe
           s   + or - sign
         a b   floating point
               output = ( t + sb ) {*|/} sf + sa
               where t (sample time) and b are in hours, f a factor, and a an offset added
               to the result of the afore expression
               e.g. -i -TT-19.           (simple offset, subtract 19 from the hour)
               e.g. -i -TT-19./24+315    (yields days (with an offset of -19h and +315d))
               e.g. -J -TT'-55305*24'    (yields hours from the specified MJDay)
               e.g. -C3 -Tf16.10 -TT'-55305*24'
               2010 04 19  19 00 00       19.00000000     -36.39

               OBS! multiple values are cumulative:
               a's and b's are added up, f's are multiplied up. 

.bye