mdw@git.distorted.org.uk Git - sod/blob - common/defs.man

   1 .\" -*-nroff-*-
   2 .\"
   3 .\" Common definitions for Sod manpages
   4 .\"
   5 .\" (c) 2008 Straylight/Edgeware
   6 .\"
   7 .
   8 .\"----- Licensing notice ---------------------------------------------------
   9 .\"
  10 .\" This file is part of the Sensible Object Design, an object system for C.
  11 .\"
  12 .\" SOD is free software; you can redistribute it and/or modify
  13 .\" it under the terms of the GNU Library General Public License as
  14 .\" published by the Free Software Foundation; either version 2 of the
  15 .\" License, or (at your option) any later version.
  16 .\"
  17 .\" SOD is distributed in the hope that it will be useful,
  18 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 .\" GNU Library General Public License for more details.
  21 .\"
  22 .\" You should have received a copy of the GNU Library General Public
  23 .\" License along with SOD; if not, write to the Free
  24 .\" Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  25 .\" MA 02111-1307, USA.
  26 .
  27 .\"--------------------------------------------------------------------------
  28 .\" Preliminary definitions.
  29 .
  30 .\" Font selection.
  31 .ie t \{\
  32 .  if \n(.g \{\
  33 .    fam P
  34 .    ev an-1
  35 .    fam P
  36 .    ev
  37 .  \}
  38 .\}
  39 .
  40 .\" Character definitions.
  41 .ie t \{\
  42 .  ds o \(bu                            \" bullet for lists
  43 .  ds e \(*e                            \" empty nonterminal
  44 .  ds ^ \v'-.3m'\s'\\n(.s*7/10'         \" begin superscript
  45 .  ds ^e \s0\v'.3m'                     \" end superscript
  46 .  ds _ \v'.3m'\s'\\n(.s*7/10'          \" begin subscript
  47 .  ds _e \s0\v'-.3m'                    \" end subscript
  48 .\}
  49 .el \{\
  50 .  ds o o                               \" bullet for lists
  51 .  ds e \fIe\fR                         \" empty nonterminal
  52 .  ds ^ ^                               \" begin superscript
  53 .  ds ^e                                \" end superscript
  54 .  ds _ _                               \" begin subscript
  55 .  ds _e                                \" end subscript
  56 .\}
  57 .ds * \*^\(**\*(^e                      \" superscript `*' (zero or more)
  58 .ds + \*^+\*(^e                         \" superscript `+' (one or more)
  59 .
  60 .\" .hP TEXT -- start an indented paragraph with TEXT hanging off to the left
  61 .de hP
  62 .IP
  63 \h'-\w'\fB\\$1\ \fP'u'\fB\\$1\ \fP\c
  64 ..
  65 .
  66 .\" .SP -- equivalent to .TP, but indicates item should be summarized
  67 .de SP
  68 .TP
  69 ..
  70 .
  71 .\" .VS ... .VE -- present a code example
  72 .de VS
  73 .sp 1
  74 .RS
  75 .nf
  76 .ft B
  77 ..
  78 .de VE
  79 .ft R
  80 .fi
  81 .RE
  82 .sp 1
  83 ..
  84 .
  85 .\" .t( ... .t) -- tabbing: align contents at current horizontal position
  86 .de t(
  87 'in +\\n(.ku
  88 ..
  89 .de t)
  90 .in
  91 ..
  92 .
  93 .\" .| -- syntax alternative on a new line
  94 .de |
  95 .br
  96 \h'4n'|
  97 ..
  98 .
  99 .\" .< -- newline and indent only in nroff mode (for shorter lines)
 100 .ie t \{\
 101 .  de <
 102 ..
 103 .\}
 104 .el \{
 105 .  de <
 106 .    br
 107 \h'4n'
 108 ..
 109 .\}
 110 .
 111 .\"----- That's all, folks --------------------------------------------------