home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 2 / FFMCD02.bin / useful / lib / groff / tmac / tmac.doc.old < prev    next >
Text File  |  1993-12-19  |  36KB  |  1,859 lines
  1. .\"
  2. .\" Copyright (c) 1990 The Regents of the University of California.
  3. .\" All rights reserved.
  4. .\"
  5. .\" Redistribution and use in source and binary forms, with or without
  6. .\" modification, are permitted provided that the following conditions
  7. .\" are met:
  8. .\" 1. Redistributions of source code must retain the above copyright
  9. .\"    notice, this list of conditions and the following disclaimer.
  10. .\" 2. Redistributions in binary form must reproduce the above copyright
  11. .\"    notice, this list of conditions and the following disclaimer in the
  12. .\"    documentation and/or other materials provided with the distribution.
  13. .\" 3. All advertising materials mentioning features or use of this software
  14. .\"    must display the following acknowledgement:
  15. .\"    This product includes software developed by the University of
  16. .\"    California, Berkeley and its contributors.
  17. .\" 4. Neither the name of the University nor the names of its contributors
  18. .\"    may be used to endorse or promote products derived from this software
  19. .\"    without specific prior written permission.
  20. .\"
  21. .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22. .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23. .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24. .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25. .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26. .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27. .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28. .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29. .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30. .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31. .\" SUCH DAMAGE.
  32. .\"
  33. .\"     @(#)tmac.doc.old    5.2 (Berkeley) 3/13/91
  34. .\"     Slightly modified by jjc@jclark.com to work with groff as well.
  35. .\"
  36. .\" Assume nroff on crt's only if cR==1
  37. .if n .nr cR 1
  38. .\"    STRING CONSTANTS
  39. .\"     DITROFF
  40. .if t \{\
  41. .\"    Address Style
  42. .ds aD \fI
  43. .\"    Argument Reference Style
  44. .ds aR \f(CO
  45. .\"    Interactive Comand Modifier (flag)
  46. .ds cM \f(CB
  47. .\"    Emphasis (in the English sense - usually italics)
  48. .ds eM \fI
  49. .\"    Errno Style
  50. .ds eR \fC
  51. .\"    Environment Variable Style
  52. .ds eV \fC
  53. .\"    Command Line Flag Style
  54. .ds fL \f(CB
  55. .\"    Header String Style
  56. .ds Hs \fR
  57. .\"    Interactive Command Style
  58. .ds iC \f(CB
  59. .\"    Literal Style
  60. .ds lI \fC
  61. .\"    Left Parenthesis Style
  62. .ds lP \fR\|(\|\fP
  63. .\"    Right Parenthesis Style
  64. .ds rP \fR\|)\|\fP
  65. .\"    Options Open Bracket Style
  66. .ds lB \fR\^[\^\fP
  67. .\"    Options Open Bracket Style
  68. .ds rB \fR\^]\fP
  69. .\"    Name (subject of manpage) Style
  70. .ds nM \f(CB
  71. .\"    Pathname Style
  72. .ds pA \fC
  73. .\"    Accepted punctuation string for -mdoc syntax
  74. .ds Pu \fR[.,:;(\^)[\^]\fR]
  75. .\"    Section Header Style
  76. .ds Sp \s12\fB
  77. .\" .ds sT \s-2\fR
  78. .\"    Symbolic Emphasis (boldface)
  79. .ds sY \f(CB
  80. .\"    Generic Variable Style
  81. .ds vA \fI
  82. .\"    Volume Title Style
  83. .ds Vs \fR
  84. .\"    Cross Reference STyle (man page only)
  85. .ds xR \fC
  86. .\"    Math *
  87. .tr *\(**
  88. .\}
  89. .\"    NROFF
  90. .if n \{\
  91. .\"    Address Style
  92. .ds aD \fI
  93. .\"    Argument Reference Style
  94. .ds aR \fI
  95. .\"    Interactive Command Modifier (flag)
  96. .ds cM \fB
  97. .\"    Emphasis (in the English sense - usually italics)
  98. .ds eM \fI
  99. .\"    Errno Style
  100. .ds eR \fR
  101. .\"    Environment Variable Style
  102. .ds eV \fR
  103. .\"    Command Line Flag Style
  104. .ds fL \fB
  105. .\"    Header String Style
  106. .ds Hs \fR
  107. .\"    Interactive Command Style
  108. .ds iC \fB
  109. .\"    Literal Style
  110. .ds lI \fR
  111. .\"    Left Parenthesis Style
  112. .ds lP \fR\|(\fP
  113. .\"    Right Parenthesis Style
  114. .ds rP \fR\|)\fP
  115. .\"    Options Open Bracket Style
  116. .ds lB \fR\|[\|\fP
  117. .\"    Options Open Bracket Style
  118. .ds rB \fR\|]\fP
  119. .\"    Name (subject of manpage) Style
  120. .ds nM \fB
  121. .\"    Pathname Style
  122. .ds pA \fI
  123. .\"    Accepted punctuation string for -mdoc syntax
  124. .ds Pu [.,;:()[]]
  125. .\"    Section Header Style
  126. .ds Sp \s12\fB
  127. .\"    .ds sT \s-2\fR
  128. .\" .ds sT \s-2\fR
  129. .\"    Symbol, Mode or Mask Style
  130. .ds sY \fB
  131. .\"    Generic Variable Style
  132. .ds vA \fI
  133. .\"    Volume Title Style
  134. .ds Vs \fR
  135. .\"    Cross Reference Style (man page only)
  136. .ds xR \fR
  137. .\}
  138. .\"    INDENTS - Subheaders(sI), Text(Ti) between Section Headers and Subsects
  139. .if t \{\
  140. .    nr sI \w'\fC,'u*5
  141. .    nr Ti \n(sIu
  142. .\}
  143. .if n \{\
  144. .    nr sI .5i
  145. .    nr Ti .5i
  146. .\}
  147. .\"    Flags for macros names which are used only for .Ds
  148. .nr dI 6n
  149. .nr dC 1
  150. .nr dL 1
  151. .nr dR 1
  152. .\"    INDENT WIDTHS (for Lists)
  153. .\"    Width Needed for Address Tag (indented amount)
  154. .nr Ad 12n
  155. .\"    Angle Quote Width
  156. .nr Aq 12n
  157. .\"    Width Needed for Argument
  158. .nr Ar 12n
  159. .\"    Width Needed for Column offset
  160. .nr Cl 15n
  161. .\"    Width neeeded for Interactive Command Modifier
  162. .nr Cm 10n
  163. .\"    Width Needed for Complex Expressions
  164. .nr Cx 20n
  165. .\"    Indent Width Needed for Display (right and left margins)
  166. .nr Ds 6n
  167. .\"    Double Quote Width
  168. .nr Dq 12n
  169. .\"    tI is dependent on Ds and used by .Dp
  170. .nr tI \n(Dsu
  171. .\"    Width Needed for Display
  172. .nr Em 10n
  173. .\"    Width Needed for Errno Types
  174. .nr Er 15n
  175. .\"    Width Needed for Environment Variables
  176. .nr Ev 15n
  177. .\"    Width Needed for Example Indent
  178. .nr Ex 10n
  179. .\"    Width Needed for Flag
  180. .nr Fl 10n
  181. .\"    Width Needed for Function
  182. .nr Fn 16n
  183. .\"    Width neeeded for Interactive Command Name
  184. .nr Ic 10n
  185. .\"    Width Needed for Constant
  186. .nr Li 16n
  187. .\"    Width Needed for Math Symbol ? not sure if needed
  188. .nr Ms 6n
  189. .\"    Width Needed for Name
  190. .nr Nm 10n
  191. .\"    Width Needed for Option Begin
  192. .nr Ob 14n
  193. .\"    Width Needed for Option End
  194. .nr Oe 14n
  195. .\"    Width Needed for Option (one line)
  196. .nr Op 14n
  197. .\"    Width Needed for Pathname
  198. .nr Pa 32n
  199. .\"    Parenthesis Quote Width
  200. .nr Pq 12n
  201. .\"    Single Quote Width
  202. .nr Sq 12n
  203. .\"    Width Needed for Symbols, Modes or Masks
  204. .nr Sy 6n
  205. .\"    Width needed for default or unknown text width
  206. .nr Tx 22n
  207. .\"    Width Needed for Generic Variable
  208. .nr Va 12n
  209. .\"    Width Needed for Cross Reference, should the cross ref be annotated.
  210. .nr Xr 10n
  211. .\" PARAGRAPH SPACE
  212. .if t \{\
  213. .    nr Pp .5v
  214. .\}
  215. .if n \{\
  216. .    nr Pp 1v
  217. .\}
  218. .\"    PAGE LAYOUT
  219. .\" .Li Tagged Paragraph Style - zero if break on oversized tag
  220. .\" one if add em space and continue filling line.
  221. .nr tP 0
  222. .\" Page Layout Macro
  223. .de pL
  224. .\"    DITROFF
  225. .ie t \{\
  226. .\" Header Margin
  227. .    nr Hm .5i
  228. .\" Footer Margin
  229. .    nr Fm .5i
  230. .\" Line length
  231. .    nr ll 5.5i
  232. .\" Line length
  233. .    ll 5.5i
  234. .\" Title length
  235. .    nr lt 5.5i
  236. .\" Title length
  237. .    lt 5.5i
  238. .\" Page offset
  239. .    nr po 1.56i
  240. .\" Page offset
  241. .    po 1.56i
  242. .\" Vertical space distance (from Section headers/Lists/Subsections)
  243. .    nr vV .5v
  244. .\" em space
  245. .    ds tP \|\|\|\|\|\|
  246. .\}
  247. .el \{\
  248. .\" Line length
  249. .    nr ll 78n
  250. .    ll 78n
  251. .\" Title length
  252. .    nr lt 78n
  253. .\" Title length
  254. .    lt 78n
  255. .\" Page offset
  256. .    nr po 0i
  257. .\" Page offset
  258. .    po 0i
  259. .\" Vertical space distance (from Section headers/Lists/Subsections)
  260. .    nr vV 1v
  261. .\" em space
  262. .    ds tP \0\0
  263. .\" Test for crt
  264. .    ie \\n(cR .nr Hm 0
  265. .    el .nr Hm .5i
  266. .\" Footer Margin
  267. .    nr Fm .5i
  268. .\}
  269. ..
  270. .\" Adjustment mode
  271. .if n \{\
  272. .ad l
  273. .na
  274. ..
  275. .\}
  276. .\" PREDEFINED STRINGS
  277. .if t \{\
  278. .    ds <= \(<=
  279. .    ds >= \(>=
  280. .    ds Lq \&``
  281. .    ds Rq \&''
  282. .    ds ua \(ua
  283. .    ds aa \(aa
  284. .    ds ga \(ga
  285. .    ds sR \(aa
  286. .    ds sL \(ga
  287. .\}
  288. .if n \{\
  289. .    ds <= \&<\&=
  290. .    ds >= \&>\&=
  291. .       ds Rq ''
  292. .       ds Lq ``
  293. .    ds ua ^
  294. .    ds aa '
  295. .    ds ga `
  296. .    ds sL `
  297. .    ds sR '
  298. .\}
  299. .\" Note: The distances from the bottom or top of the page are set
  300. .\" in headers (macro .hK): to -1.25 for troff, and -1.167 for nroff
  301. .\" bottoms, and top is 0.
  302. .\"
  303. .\"    .Dt Document/manpage_title section/chapter volume
  304. .\"        The \{ and \} is necessary as roff doesn't nest if-elses
  305. .\"        properly, especially with .ds.
  306. .\"    TODO: separate Dt into Dt, Ch and Vt for supp docs.
  307. .de Dt
  308. .ds dT UNTITLED
  309. .ds vT Local
  310. .ds cH Null
  311. .\"     Volume and Section Number or Chapter Number
  312. .if !"\\$1"" .ds dT \\$1
  313. .if !"\\$2"" \{\
  314. .    ds cH \\$2
  315. .    if "\\$3"" \{\
  316. .        \" Volume Title if none given
  317. .        if \\$2>=1 .if \\$2<=8 \{\
  318. .            ds vT UNIX Reference Manual
  319. .            if \\$2>1 .if \\$2<6 .ds vT UNIX Programmer's Manual
  320. .            if "\\$2"8" .ds vT UNIX System Manager's Manual
  321. .        \}
  322. .        if "\\$2"unass"  .ds vT DRAFT
  323. .        if "\\$2"draft"  .ds vT DRAFT
  324. .        if "\\$2"paper"  .ds vT Null
  325. .    \}
  326. .\}
  327. .if !"\\$3"" \{\
  328. .    \" Volume Title if given
  329. .    if "\\$3"USD"   .ds vT UNIX User's Supplementary Documents
  330. .    if "\\$3"PS1"   .ds vT UNIX Programmers's Supplementary Documents
  331. .    if "\\$3"AMD"   .ds vT UNIX Ancestral Manual Documents
  332. .    if "\\$3"SMM"   .ds vT