pubmac 51 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284
  1. ." $Header$
  2. .LL 6.5i
  3. .MS T E
  4. \!.TL `\\n(S1``PUBMAC user's guide`
  5. .ME
  6. .MS T O
  7. \!.TL `PUBMAC user's guide``\\n(S1`
  8. .ME
  9. .MS B E
  10. \!.TL '%'''
  11. .ME
  12. .MS B O
  13. \!.TL '''%'
  14. .ME
  15. .SM S1 B S
  16. .IN 5
  17. .N
  18. .AD R
  19. Report no. 4
  20. .N
  21. second revision
  22. .N
  23. .AD B
  24. .N 10
  25. .CS
  26. .SS 14
  27. .BS
  28. PUBMAC
  29. .BE
  30. .N 1
  31. .US
  32. .SS 12
  33. A Set of NROFF/TROFF-Macros
  34. to Format Publications
  35. .UE
  36. .N 1
  37. User's Guide
  38. .N 2
  39. Third, revised edition
  40. March 1980
  41. .N 11
  42. .SS 10
  43. Katholieke Universiteit Nijmegen
  44. Informatics Department
  45. Nijmegen, The Netherlands.
  46. .CE
  47. .N 8
  48. .U ABSTRACT
  49. .N 1
  50. A set of NROFF/TROFF macros is presented, intended to facilitate the
  51. formatting of a paper for publication purposes.
  52. Predefined macros are supplied for the most frequent activities.
  53. Sectioning, section-numbering, construction
  54. of a table of contents and some other important
  55. facilities are automated.
  56. .S1 Introduction
  57. The UNIX text formatting program NROFF/TROFF
  58. .RS "NROFF/TROFF"
  59. J.F. Ossanna, NROFF/TROFF User's Manual, Bell Laboratories, Murray Hill,
  60. New Jersey
  61. .RE
  62. allows the user to define his own commands via a macro mechanism.
  63. The present paper describes PUBMAC, a set of macros for a set
  64. of very often repeated activities encountered in the text formatting
  65. process for a paper to be published.
  66. .P
  67. These activities comprise e.g. the division of a paper into
  68. sections, the automatic generation of a table of contents, footnote
  69. handling etc.
  70. PUBMAC is intended to simplify the user-interface of NROFF/TROFF in such a way
  71. that it is suitable for use by personnel with little formal training
  72. and no special talent for informatics.
  73. The macro set described in this Guide is designed
  74. by Thijs Zoethout
  75. after the
  76. .RS PUBMAC
  77. H.M. Stahl, PUBMAC User's Guide, Report no.4 revised, Informatica Department,
  78. Nijmegen University
  79. .RE
  80. macro set written by Hans-Michael Stahl for a previous version of NROFF.
  81. The set was later adapted for use on a high-quality laser printer
  82. allowing use of the full range of
  83. .U troff's
  84. capabilities
  85. by E. G. Keizer.
  86. .N
  87. The construction of the macro set was influenced by the SYSPUB macro
  88. set developed for SCRIPT at the University of Waterloo and described
  89. in
  90. .RS "SYSP77" "."
  91. SYSPUB User's Guide, University of Waterloo Computing Centre,
  92. 1977
  93. .RE
  94. .P
  95. However, in contrast to SCRIPT, NROFF/TROFF only allows two characters as name for commands,
  96. so that it is quite difficult to select mnemonic command names.
  97. We tried our best to make full use of the expressive power
  98. of two characters...
  99. .P
  100. PUBMAC can be obtained from the author.
  101. Prerequisites for its use are:
  102. .PS
  103. .PT
  104. a machine with the UNIX operating system,
  105. with NROFF or TROFF,
  106. .PT
  107. an output device e.g. a daisywheel printer or laser printer.
  108. .PE
  109. .S2 Invoking PUBMAC
  110. calling NROFF/TROFF with the option
  111. .B -mkun,
  112. e.g.
  113. .DS I 6
  114. .BS
  115. \&troff -mkun file....
  116. .BE
  117. .DE
  118. The reader who desires to make use of further options may consult
  119. [NROFF/TROFF].
  120. Output from the preprocessors
  121. .UW tbl ,
  122. .U eqn
  123. and
  124. .U refer
  125. is recognized by PUBMAC.
  126. .N 1
  127. The commands needed to print the formatted text differ between
  128. installations.
  129. .S2 PUBMAC Input
  130. As for NROFF/TROFF, each line of
  131. the input files for PUBMAC either contains text to be formatted
  132. or is a command line.
  133. A command line begins with a control
  134. character (under PUBMAC ".") followed by the name of a
  135. PUBMAC command or of a NROFF/TROFF request.
  136. Command lines which do not contain a known PUBMAC or NROFF/TROFF
  137. command are ignored without complaints.
  138. .S2 Form of the PUBMAC commands
  139. All PUBMAC commands have a name consisting of one or two capital letters
  140. or a capital letter followed by a digit.
  141. Most commands embedding some text, i.e. a start and an end command,
  142. have a capital
  143. .B S
  144. (for start) and a capital
  145. .B E
  146. (for end)
  147. as second letter to gain at least a bit of systematics.
  148. .P
  149. Some commands may have operands; these have to be enclosed
  150. in double quotes ("), if they contain blanks.
  151. The number of operands is restricted to 9, but operands can
  152. be grouped into one operand by enclosing them in double quotes.
  153. .P
  154. Operands may be optional; this is indicated in the description by surrounding the
  155. operand by square brackets (\ [\ and\ ]\ ).
  156. A sequence of one or more operands is indicated by
  157. one operand followed by ellipses, e.g
  158. .B title... .
  159. .S2 NROFF/TROFF Commands under PUBMAC
  160. As PUBMAC does a lot of administration, NROFF/TROFF commands changing
  161. global values (e.g. linelength, current indentation) nearly
  162. always disturb this administration.
  163. Therefore it is recommended not to use NROFF/TROFF commands
  164. if not stated otherwise.
  165. Also, a NROFF/TROFF command can be renamed and thus not available
  166. any more under the old name.
  167. .N
  168. The renamed commands are:
  169. .DS I
  170. .TS 0
  171. l l s
  172. l l l.
  173. PUBMAC NROFF/TROFF
  174. \&.PO .po set page offset
  175. \&.TL .tl define title line
  176. .TE 0
  177. .DE
  178. .S2 PUBMAC Output
  179. Input text to PUBMAC is subject to two formatting processes:
  180. filling and adjusting.
  181. Filling means that output lines are about equally filled
  182. within the current line length;
  183. it is achieved
  184. by taking words from input lines as long until
  185. a complete output line is formed.
  186. A word, in the context of formatting, is any text
  187. surrounded by blanks.
  188. Adjusting means that all output lines are adjusted
  189. to some uniformity.
  190. This is achieved by expanding the blank spaces between
  191. output words as necessary or leaving one or both margins ragged.
  192. .P
  193. Under PUBMAC normally filling and adjusting
  194. are switched on by default, but both may be turned off separately
  195. (within certain limits).
  196. .N 5
  197. .U Acknowledgement
  198. .N
  199. I wish to thank all PUBMAC users,
  200. for their help in finding
  201. errors, and their proposals for correcting them.
  202. .S1 Global Structure
  203. This section describes the basic PUBMAC commands necessary to
  204. divide a paper into sections, paragraphs etc.
  205. If you are using PUBMAC for the first
  206. time, you are recommended to experiment with the commands described
  207. herein on a small document.
  208. .DS I
  209. .TS 0
  210. l l.
  211. \&.RP select report layout
  212. \&.S1 to create first level sections
  213. \&.S2 to create second-level sections
  214. \&.S3 to create third-level sections
  215. \&.S4 to create fourth-level sections
  216. \&.AP to start an appendix
  217. \&.SN to set the start value for section numbers
  218. \&.P to start a paragraph
  219. \&.A to start an alinea
  220. \&.PS to start a list of points
  221. \&.PT to start a point
  222. \&.PE to end a list of points
  223. .TE 0
  224. .DE
  225. .S2 Selecting a Layout
  226. PUBMAC offers two kinds of layout:
  227. .PS
  228. .PT
  229. the
  230. .U report layout
  231. which is suited for short papers and technical notes.
  232. .PT
  233. the
  234. .U manual layout
  235. which is thought for larger publications
  236. .FS * .
  237. This PUBMAC user's guide is an example of the
  238. manual layout.
  239. .FE
  240. .PE
  241. When the manual layout is selected, the first page is reserved
  242. as a title page and not counted for page numbering purposes,
  243. no headers and footers are printed on it,
  244. and new sections appear on a new page.
  245. .A
  246. For the report layout no title page is reserved, thus the
  247. output text immediately starts on the first page.
  248. A new section is not forced to appear on a new page.
  249. .A
  250. The manual layout is selected by default;
  251. to select the report layout, use the command
  252. .DS I 6
  253. .BS
  254. \&.RP
  255. .BE
  256. .DE
  257. .UW ( R e P ort).
  258. This command has to appear in the input text before the first
  259. .B .S1
  260. (see below).
  261. .S2 Sections
  262. PUBMAC offers commands
  263. to divide a paper into sections and subsections.
  264. Sections are numbered automatically and their
  265. numbers, titles and page numbers are collected for the table of contents
  266. which can be put out at the end of the report.
  267. .P
  268. To start a new section, use the command
  269. .DS I 6
  270. .BS
  271. \&.S1 title...
  272. .BE
  273. .DE
  274. where
  275. .B title...
  276. is the title of the section.
  277. If the manual report is selected, the section will appear on a new page and the title will be
  278. translated to capital letters and centered.
  279. If the report layout is chosen, the title only will be underlined and PUBMAC
  280. takes care that the title and the first 6 lines of the section
  281. text
  282. will appear on the same page.
  283. The text of a section immediately follows the
  284. .B .S1
  285. command.
  286. .P
  287. A section may be divided further into subsections, which again
  288. may be divided further etc, up to the level 4:
  289. .DS I 6
  290. .BS
  291. \&.S2 title...
  292. \&.S3 title...
  293. \&.S4 title...
  294. .BE
  295. .DE
  296. All subsections will be numbered automatically and their titles
  297. collected for the table of contents.
  298. The title of second-,
  299. third- and fourth-level subsections will be underlined;
  300. to make the underlining continuous,
  301. blanks separating the single words of
  302. .B title...
  303. will be translated to underscores.
  304. PUBMAC takes care, that the title and the first 5 lines of the text
  305. of subsections
  306. will appear on the same page.
  307. .P
  308. As an example, the next section was prefixed by
  309. .B .S2
  310. .BW Appendices .
  311. .S2 Appendices
  312. To start an appendix, use the command
  313. .DS I 6
  314. .BS
  315. \&.AP title...
  316. .BE
  317. .DE
  318. .UW ( AP pendix).
  319. This command acts like
  320. .B .S1
  321. with the exception, that appendices are numbered with capital letters instead of
  322. arabic numbers.
  323. .P
  324. To divide an appendix into further sections, use the
  325. .B .S2, .S3
  326. and
  327. .B .S4
  328. commands as explained above.
  329. .S2 Setting the Section Numbers
  330. Sometimes the need is felt to format a large paper not as a
  331. whole but in parts, especially when the final state
  332. of the paper has not yet been reached. Nevertheless the parts of
  333. the paper should contain consecutive section numbers
  334. and the correct page numbers.
  335. To achieve this, use the command
  336. .DS I 6
  337. .BS
  338. \&.SN s1 [s2 [s3 [s4 [ap]]]]
  339. .BE
  340. .DE
  341. .UW ( S ection
  342. .UW N umbers).
  343. The operands
  344. .B s1, s2, s3, s4
  345. determine the start value for the numbering of following sections and subsections.
  346. The operand
  347. .B ap
  348. serves to set the appendix number to the desired start value.
  349. .P
  350. To get the full table of contents and a complete
  351. bibliography list, the paper must be formatted as a whole.
  352. .S2 Paragraphs
  353. Two commands are supplied to start a new paragraph.
  354. They take care, that at least the first two
  355. lines of a paragraph are not split across a page boundary.
  356. .P
  357. To start a new paragraph, use the
  358. .DS I 6
  359. .BS
  360. \&.P [count [indent]]
  361. .BE
  362. .DE
  363. .UW ( P aragraph)
  364. command. The first line of the paragraph will be indented
  365. by
  366. .B indent
  367. (default is 3) columns and it will be separated from the previous paragraph by
  368. .B count
  369. (default is 1) blank line(s).
  370. .P
  371. If a paragraph should not be preceded by a blank line, use the command
  372. .DS I 6
  373. .BS
  374. \&.A [count [indent]]
  375. .BE
  376. .DE
  377. .UW ( A linea),
  378. which has the same effect as
  379. .B .P
  380. except that the operand
  381. .B count
  382. has the default 0.
  383. .S2 Lists of Points
  384. It is often desired to present a number of related items
  385. as a list of points. The PUBMAC commands
  386. .B .PS, .PT
  387. simplify the creation of such list.
  388. .P
  389. The command
  390. .DS I 6
  391. .BS
  392. \&.PS [style] [indentation] [ [prefix] suffix ]
  393. .BE
  394. .DE
  395. .UW ( P oint
  396. list
  397. .UW S tart)
  398. starts a list of points.
  399. The text of each point is indented from the current left margin and
  400. preceded by a label.
  401. .P
  402. .NE 13
  403. The operand
  404. .B style
  405. selects the labeling style of the points following the
  406. .B .PS
  407. command.
  408. The following styles are available:
  409. .PS
  410. .PT a:
  411. the points are labeled with small letters (a,b,..aa,bb,...);
  412. .PT A:
  413. the points are labeled with capital letters (A,B,..AA,BB...);
  414. .PT i:
  415. the points are labeled with small roman numbers (i,ii,iii...);
  416. .PT I:
  417. the points are labeled with capital roman numbers (I,II,III...);
  418. .PT 1:
  419. the points are labeled with arabic numbers (1,2,3...);
  420. .PE
  421. If
  422. .B style
  423. is not any of these then each point is labeled with the operand
  424. .BW style .
  425. .A
  426. The default is
  427. .DS I 6
  428. .BS
  429. \&.PS -
  430. .BE
  431. .DE
  432. The operand
  433. .B indentation
  434. determines how many columns from the
  435. current left margin the text of the points in the list is to be
  436. indented.
  437. If this operand is not specified, the default value 3 will be used.
  438. All operands remain valid for all points in the list.
  439. .P
  440. If you want the label selected by
  441. .B .PS
  442. to be followed
  443. by an additional string, for instance for labels as
  444. .B 1)
  445. and
  446. .B 2),
  447. use
  448. the operand
  449. .BW suffix .
  450. It determines the string to follow
  451. the point-label selected by
  452. .BW .PS .
  453. The default
  454. .B suffix
  455. is the empty string "".
  456. The operand
  457. .B prefix
  458. determines the string to be inserted before each point label.
  459. .P
  460. To start a point in such a list, use
  461. .DS I 6
  462. .BS
  463. \&.PT [label]
  464. .BE
  465. .DE
  466. .UW ( P oin T ).
  467. The text of the point has to follow on the next
  468. input lines.
  469. The optional operand
  470. .B label
  471. allows the replacement of the label selected
  472. by the
  473. .B .PS
  474. command ("-" or numbers as selected by "style")
  475. for a single point.
  476. If the text of the label is longer than the indentation selected
  477. by
  478. .B .PS,
  479. the text of the point in the output will appear on a new line.
  480. .P
  481. To continue the list of points, simply repeat the
  482. .B .PT
  483. command for every new point.
  484. .P
  485. A list of points is terminated by the command
  486. .DS I 6
  487. .BS
  488. \&.PE
  489. .BE
  490. .DE
  491. .UW ( P oint
  492. list
  493. .UW E nd).
  494. The command returns to the indentation level being
  495. actual when the last
  496. .B .PS
  497. was encountered by PUBMAC.
  498. .P
  499. Lists of points may be nested up to a maximum level of nine.
  500. A
  501. .B .PS
  502. command
  503. inside the actual list will create a new, nested list of
  504. points.
  505. A new numbering style and indentation value
  506. can be selected for this nested list of points.
  507. To return to the previous list of points, use the
  508. .B .PE
  509. command, which also will restore the old operand values.
  510. After being returned to the old list, the numbering
  511. of further points will continue as selected when this list was started.
  512. .P
  513. To give an impression how the
  514. .B .PT
  515. command can be used, the following example is given. The input text:
  516. .DS B
  517. .BS
  518. \&The .PT command can be used
  519. \&.PS a 5 )
  520. \&.PT
  521. \&to construct a list of points which appear marked and
  522. \&properly indented in the output file
  523. \&.PT
  524. \&to give a summary of information related to one point of view
  525. \&.PT
  526. \&to give more detailed information
  527. \&for a given statement in a top-down way
  528. \&.PS i 4 [ ]
  529. \&.PT
  530. \&this is possible in a nested way
  531. \&.PT
  532. \&the maximum level of nesting is nine, which
  533. \&in general will be enough
  534. \&.PE 0
  535. \&.PT
  536. \&in all respects, the .PT command
  537. \&is very useful to construct a "structured" paper.
  538. \&.PE
  539. \&Here the normal text processing continues on the
  540. \&indentation level as it was before the first .PT
  541. \&in this section.
  542. .BE
  543. .DE
  544. produces the following output:
  545. .N 1
  546. The .PT command can be used
  547. .PS a 5 )
  548. .PT
  549. to construct a list of points which appear marked and properly
  550. indented in the output file
  551. .PT
  552. to give a summary of information
  553. related to one point of view
  554. .PT
  555. to give more detailed information
  556. for a given statement in a top-down
  557. way
  558. .PS i 4 [ ]
  559. .PT
  560. this is possible in a nested way
  561. .PT
  562. the maximum level of nesting is nine, which
  563. in general will be enough
  564. .PE 0
  565. .PT
  566. in all respects, the .PT command
  567. is very useful to construct a "structured"
  568. paper.
  569. .PE
  570. Here the normal text processing continues on the
  571. indentation level as it was before the first .PS
  572. in this section.
  573. .P
  574. Another application for points are lists like the
  575. command summary in appendix B.
  576. The whole summary is a list of points preceded by
  577. .B .PS 1 8,
  578. every item in the list is a point started with
  579. .B .PT xx,
  580. where
  581. .B xx
  582. is the command name.
  583. .S1 Local Layout
  584. Two groups of commands are provided to determine the
  585. local layout:
  586. commands working on lines or groups of lines
  587. (to create empty lines, for indenting, centering, etc),
  588. and commands working on words (underlining, marking etc).
  589. .DS I
  590. .TS 0
  591. l l.
  592. \&.N [count] Begin new line, preceded by count blank lines
  593. \&.BP Begin new page
  594. \&.IS [count] Start indentating by count columns
  595. \&.IE End indentation
  596. \&.UN Undent temporarily
  597. \&.CS Start centering
  598. \&.CE End centering
  599. \&.US Start underlining
  600. \&.UE End underlining
  601. \&.BS Start bold type face
  602. \&.BE End bold type face
  603. \&.NE [count] Need count lines on the current page
  604. \&.U word... Underline word...
  605. \&.CU word... Continuous underline word...
  606. \&.B word... Bold face word...
  607. .TE 0
  608. .DE 0
  609. .S2 Line Oriented Commands
  610. The command
  611. .DS I 6
  612. .BS
  613. \&.N [count]
  614. .BE
  615. .DE
  616. .UW ( N ewline)
  617. starts a new output line,
  618. preceded by
  619. .B count
  620. blank lines.
  621. If
  622. .B count
  623. is omitted, no blank lines are generated but only a new line is begun.
  624. The command
  625. .DS I 6
  626. .BS
  627. \&.BP
  628. .BE
  629. .DE
  630. .UW ( B egin
  631. .UW P age)
  632. causes PUBMAC to put out the current page and start a new one.
  633. .NE 6
  634. .P
  635. The command
  636. .DS I 6
  637. .BS
  638. \&.IS [left indent [right indent [count]]]
  639. .BE
  640. .DE
  641. .UW ( I ndentation
  642. .UW S tart)
  643. indents the output by
  644. .B left indent
  645. (default is 3) columns at the left margin.
  646. Indents the output by
  647. .B right indent
  648. (default is 0) columns at the right margin,
  649. after generating
  650. .B count
  651. (default 0) blank lines.
  652. .DS I 6
  653. .BS
  654. \&.UN
  655. .BE
  656. .DE
  657. .UW ( UN dent)
  658. undents the next line temporarily, and the command
  659. .DS I 6
  660. .BS
  661. \&.IE [count]
  662. .BE
  663. .DE
  664. .UW ( I ndentation
  665. .UW E nd)
  666. undents the text permanently and
  667. generates
  668. .B count
  669. (default 0) blank lines.
  670. .P
  671. Indentations can not be nested.
  672. All three commands act as a break, i.e. put out a partially filled line.
  673. .P
  674. To center a piece of text, use the commands
  675. .DS I 6
  676. .BS
  677. \&.CS [count]
  678. \&.CE [count]
  679. .BE
  680. .DE
  681. .UW ( C enter
  682. .UW S tart,
  683. .UW C enter
  684. .UW E nd).
  685. All input lines between the two commands will
  686. appear centered, line for line without filling, in the output.
  687. The operand
  688. .B count
  689. specifies the number of blank lines preceding and following the centered text
  690. (default 0).
  691. Both commands act as a break.
  692. For instance, the title page of this report was formatted with the
  693. commands
  694. .DS I 6
  695. .BS
  696. \&.CS
  697. \&PUBMAC
  698. \&.N 1
  699. \&A Set of NROFF/TROFF-Macros
  700. \&to Format Publications
  701. \&.N 1
  702. \&User's Guide
  703. \&.N 2
  704. \&Third, revised edition
  705. \&March 1980
  706. \&.N 11
  707. \&.CE
  708. .BE
  709. .DE
  710. .P
  711. To underline a piece of text, use the commands
  712. .DS I 6
  713. .BS
  714. \&.US [C]
  715. \&.UE
  716. .BE
  717. .DE
  718. The text between the two commands will appear underlined.
  719. If no operand is specified, only letters and digits will be underlined and
  720. filling will take place.
  721. The optional operand C stands for Continuous underline.
  722. In this mode all characters and spaces will be underlined,
  723. no filling will occur.
  724. .P
  725. To print a piece of text in boldface, use the commands
  726. .DS I 6
  727. .BS
  728. \&.BS
  729. \&.BE
  730. .BE
  731. .DE
  732. .UW ( B old
  733. .UW S tart,
  734. .UW B old
  735. .UW E nd).
  736. The text between the two commands will appear in boldface.
  737. The result highly depends on the output device.
  738. In some cases the effect will be nil.
  739. .P
  740. Normally an input line starting with the control
  741. character "." or "\'" is interpreted as a command.
  742. To consider such lines as normal input,
  743. precede each of them by "\e&".
  744. .NE 5
  745. .P
  746. To assure that a certain piece of text is not split across a page boundary,
  747. use the command
  748. .DS I 6
  749. .BS
  750. \&.NE count
  751. .BE
  752. .DE
  753. .UW ( NE ed)
  754. which has no visible effect if there are still
  755. .B count
  756. lines left on the current output page,
  757. but causes a page eject if not.
  758. .S2 Word Oriented Commands
  759. The following commands all take a list of words as operands
  760. which are subject to a special treatment.
  761. None of the commands causes a break.
  762. .P
  763. To underline a sequence of words, use
  764. .DS I 6
  765. .BS
  766. \&.U word...
  767. .BE
  768. .DE
  769. .UW ( U nderline).
  770. The letters and digits in the operands
  771. .B word...
  772. will appear underlined in the output text.
  773. The command
  774. .P
  775. .DS I 6
  776. .BS
  777. \&.CU word....
  778. .BE
  779. .DE
  780. .UW ( C ontinuous
  781. .UW U nderline)
  782. will underline
  783. .U all
  784. characters,
  785. including the separating spaces.
  786. .P
  787. The command
  788. .DS I 6
  789. .BS
  790. \&.B word...
  791. .BE
  792. .DE
  793. .UW ( B old)
  794. will print the operands
  795. .B word...
  796. in bold face.
  797. The result highly depends on the output device.
  798. .S1 Tables, Figures and Formulas
  799. PUBMAC provides commands which allow the user to
  800. do his own formatting for figures, examples and so on.
  801. Another related group of commands allows the user
  802. to lay special stress on a piece of text.
  803. For these purposes, the following commands are available:
  804. .DS I
  805. .TS 0
  806. l l.
  807. \&.DS start a display
  808. \&.DS M start a marked display
  809. \&.DS X start a boxed display
  810. \&.DE end a display
  811. \&.DB allow breaking of following display
  812. .TE 0
  813. .DE
  814. A
  815. .U display
  816. is a text which should be kept together, i.e., if possible,
  817. should not be split across a page
  818. boundary, but moved as a whole to the next page
  819. (however, see
  820. .B .DB
  821. below).
  822. Provisions for several display types are made in PUBMAC.
  823. To start a display, use
  824. .DS I 6
  825. .BS
  826. \&.DS [mode]
  827. .BE
  828. .DE
  829. .UW ( D isplay
  830. .UW S tart),
  831. where
  832. .B mode
  833. determines the kind of display.
  834. To return to normal text processing, invoke the command
  835. .DS I 6
  836. .BS
  837. \&.DE [count]
  838. .BE
  839. .DE
  840. .UW ( D isplay
  841. .UW E nd).
  842. Where the operand
  843. .B count
  844. specifies the number of blank lines following the display (default 1).
  845. .N
  846. All text between both commands is subject to the formatting chosen
  847. by the operands of the selected display.
  848. Restrictions in the use of displays are discussed below.
  849. .S2 Simple Displays
  850. To start a simple display, use the command
  851. .DS I 6
  852. .BS
  853. \&.DS
  854. .BE
  855. .DE
  856. .UW ( D isplay
  857. .UW S tart).
  858. PUBMAC switches to no-format mode
  859. i.e. input text lines are neither filled nor
  860. adjusted.
  861. The user himself has to take care for the formatting, especially that
  862. the input text does not exceed the current linelength.
  863. Other PUBMAC commands may be used inside the display to do
  864. the formatting.
  865. .S2 Marked and Boxed Displays
  866. To lay special stress on a display,
  867. e.g. to achieve more contrast between examples and running text,
  868. it can be
  869. .UW M arked
  870. or
  871. .UW bo X ed.
  872. Optional operands specify the distance of the boundary of the display
  873. from the left and right margin.
  874. To start this kind of display, use the command
  875. .DS I 6
  876. .BS
  877. \&.DS [mark] M [left-indentation]
  878. \&.DS [mark] X [left-indentation] [right-indentation]
  879. .BE
  880. .DE
  881. .UW ( D isplay
  882. .UW S tart
  883. .UW M arked,
  884. .UW D isplay
  885. .UW S tart
  886. .UW bo X ed)
  887. The boundary of the display will be
  888. indented by
  889. .B left-indentation
  890. (default 3) columns from the current left margin.
  891. .N
  892. In the case of a marked display the left hand boundary of the display
  893. will be represented by the
  894. .B mark
  895. character on each line.
  896. .N
  897. In the case of a boxed display the whole boundary of the display will
  898. be indicated by the
  899. .B mark
  900. character.
  901. The right hand boundary of the display will by indented by
  902. .B right-indentation
  903. (default 0) columns from the right margin.
  904. .N
  905. For instance, the input text
  906. .DS I 6
  907. .BS
  908. \&.DS M
  909. \&The marked display can be used
  910. \&to make programming examples, formulae and similar text
  911. \&distinguishable from the running text.
  912. \&.DE
  913. .BE
  914. .DE
  915. produces the output
  916. .DS M
  917. .BS
  918. The marked display can be used
  919. to make programming examples, formulae and similar text
  920. distinguishable from the running text.
  921. .BE
  922. .DE
  923. .S2 Inside the display
  924. Inside simple and marked displays the text will be unformatted,
  925. that is neither filled nor adjusted.
  926. Inside boxed displays the text will be formatted.
  927. .P
  928. Appending
  929. .B I
  930. or
  931. .B Q
  932. operands after the before mentioned operands, allows the user
  933. to control the formatting of the text and specify indentation
  934. inside the boundary of the display.
  935. .N
  936. The possibilities are
  937. .DS I 6
  938. .BS
  939. \&.DS [....] I [left-indentation]
  940. \&.DS [....] Q [left-indentation] [right-indentation]
  941. .BE
  942. .DE
  943. Use of the Q operand
  944. .UW ( Q uoted)
  945. causes
  946. the text inside the display to be formatted.
  947. Use of the I operand
  948. .UW ( I ndent)
  949. causes
  950. the text to be unformatted.
  951. The default for the
  952. .B left-indentation
  953. is 3 columns.
  954. .N
  955. The default for the
  956. .B right-indentation
  957. is
  958. .BW left-indentation .
  959. .P
  960. As an example, the input lines
  961. .DS
  962. .BS
  963. \&This is the sentence preceding the quotation; to start the
  964. \&quotation use the command ".DS Q".
  965. \&.DS Q 15
  966. \&This is the quoted material.
  967. \&Note that it is automatically indented from both margins.
  968. \&To terminate the quotation, use ".DE"
  969. \&.DE
  970. \&This is the first sentence following the quoted text.
  971. .BE
  972. .DE
  973. produce the following output:
  974. .NE 7
  975. This is the sentence preceding the quotation; to start the
  976. quotation use the command ".DS Q".
  977. .DS Q 15
  978. This is the quoted material.
  979. Note that it is automatically indented from both margins.
  980. To terminate the quotation, use ".DE"
  981. .DE
  982. This is the first sentence following the quoted text.
  983. .P
  984. The box
  985. .DS X 10 Q 5
  986. The text within the box display is subject
  987. to the normal PUBMAC formatting, but other PUBMAC commands
  988. can be used to get the desired layout.
  989. .CS
  990. Text for instance can appear
  991. centered
  992. within a box display
  993. .CE
  994. .DE
  995. was created with the input text:
  996. .DS I 6
  997. .BS
  998. \&.DS X 10 Q 5
  999. \&The text within a box display is subject
  1000. \&to the normal PUBMAC formatting, but other PUBMAC commands
  1001. \&can be used to get the desired layout.
  1002. \&.CS
  1003. \&Text for instance can appear
  1004. \&centered
  1005. \&within a box display
  1006. \&.CE
  1007. \&.DE
  1008. .BE
  1009. .DE
  1010. .S2 Breaking up a Display
  1011. Normally a display is moved to the next page, if there is
  1012. not enough space left on the current page to hold it completely.
  1013. Especially when a display is long,
  1014. this can lead to an annoyingly large amount of white paper
  1015. caused by the page eject.
  1016. .NE 5
  1017. The command
  1018. .DS I 6
  1019. .BS
  1020. \&.DB
  1021. .BE
  1022. .DE
  1023. .UW ( D isplay
  1024. .UW B reak
  1025. allowed),
  1026. .B .DS
  1027. allows all following displays to be split if necessary.
  1028. The same effect for one display only,
  1029. can be obtained by appending the operand
  1030. .B B
  1031. to the
  1032. .B .DS
  1033. request.
  1034. .S2 Restrictions with Displays
  1035. .PS
  1036. .PT
  1037. As already mentioned, the user has to take care in unformatted
  1038. displays that the length of the input lines does not exceed
  1039. the current output line length;
  1040. .ig
  1041. especially in multi-column mode too long display text can lead to overprinting
  1042. of columns.
  1043. ..
  1044. .PT
  1045. To prevent ugly output,
  1046. the text of a box display should not be longer than a page.
  1047. .PT
  1048. It is not possible to nest displays.
  1049. .PE
  1050. .S2 Tables
  1051. The program
  1052. .B tbl
  1053. can be used to configure complicated tables.
  1054. A description of how to use it can be found in
  1055. the
  1056. .B tbl
  1057. user's manual.
  1058. .[
  1059. %A M. E. Lesk
  1060. %T T\s-2BL\s0\(emA program to format tables
  1061. %I Bell laboratories
  1062. %C Murray Hill, New Jersey
  1063. .]
  1064. PUBMAC will handle multiple page tables correctly.
  1065. To repeat the table's heading on each page it is necessary to
  1066. surround the heading with
  1067. .B ".TS H
  1068. and
  1069. .BW .TH .
  1070. The
  1071. .B ".TS H
  1072. command replaces the normal
  1073. .B .TS
  1074. command.
  1075. .S2 Formulas
  1076. The program
  1077. .B eqn
  1078. allows you to express formulas in a rather natural syntax.
  1079. For more documentation about how to use
  1080. .B eqn
  1081. see [UPM75].
  1082. .A
  1083. The program
  1084. .B eqn
  1085. converts formula descriptions into NROFF/TROFF commands.
  1086. Typical usage is
  1087. .DS I 6
  1088. .BS
  1089. \&eqn file | troff
  1090. .BE
  1091. .DE
  1092. where file contains both the
  1093. .B eqn
  1094. and PUBMAC requests.
  1095. .P
  1096. In PUBMAC the requests
  1097. .DS I 6
  1098. .BS
  1099. \&.EQ [I/C] [indent] [L/R number] [R/L number] [count]
  1100. \&.EN [count]
  1101. .BE
  1102. .DE
  1103. .UW ( EQ uation,
  1104. .UW E quation
  1105. .UW e N d)
  1106. are recognized.
  1107. The first operand of
  1108. .B .EQ
  1109. can be
  1110. .B I
  1111. or
  1112. .B C
  1113. \&, C has the effect of centering the formula on the line and is
  1114. the default, I has the
  1115. effect of indenting the display by the value of the operand following the
  1116. .B I
  1117. (default 0).
  1118. .P
  1119. The following operands allow the formula to be numbered in one or
  1120. both margins.
  1121. .B L
  1122. or
  1123. .B R
  1124. specify the the formula should be numbered at the Left or Right margin.
  1125. The number to be placed in that margin should follow the
  1126. .B L
  1127. or
  1128. .BW R .
  1129. .P
  1130. The operand
  1131. .B count
  1132. of
  1133. .B .EQ
  1134. and
  1135. .B .EN
  1136. specifies the amount of blank lines to be inserted at the
  1137. before and after the
  1138. formula.
  1139. .S1 Page Format
  1140. If you want to use another format than the standard format
  1141. which is described below, you only may do this with special PUBMAC
  1142. commands:
  1143. .DS I
  1144. .TS 0
  1145. l l.
  1146. \&.IN set standard indentation
  1147. \&.PO set page offset
  1148. \&.PN set page number
  1149. \&.PL set page length
  1150. \&.LL set line length
  1151. \&.MS T define top margin titles
  1152. \&.MS B define bottom margin titles
  1153. \&.ME end titles
  1154. \&.IN set default indent
  1155. \&.AD adjust rigth margin
  1156. \&.NA do not adjust right margin
  1157. \&.HY switch hyphenation on
  1158. \&.NH switch hyphenation off
  1159. \&.HC set hyphenation indicator character
  1160. .TE 0
  1161. .DE
  1162. .S2 The Standard Format
  1163. PUBMAC uses the following standard values for the page format:
  1164. .DS I
  1165. the width of 3 digits for the standard indentation
  1166. 16.02 cm of text per line
  1167. pages of 29.7 cm
  1168. 25.7 cm of text per page, including the margin titles
  1169. 2 cm of blank on top of page
  1170. the page offset is 0
  1171. bottom title of page is "-- % --"
  1172. where % is the current page number in arabic numerals
  1173. adjust both margins, fill output lines
  1174. hyphenation enabled
  1175. .DE
  1176. .S2 Setting the Page Offset
  1177. If you want to have a larger
  1178. blank margin on the left hand side of your paper (e.g. for binding
  1179. purposes),
  1180. use the command
  1181. .DS I 6
  1182. .BS
  1183. \&.PO offset
  1184. .BE
  1185. .DE
  1186. .UW ( P age
  1187. .UW O ffset).
  1188. The output will be moved as a whole by
  1189. .B offset
  1190. columns to the right.
  1191. This command should precede all input text.
  1192. The default offset is zero, i.e. printing starts at the leftmost
  1193. position of the output device.
  1194. .NE 10
  1195. .S2 Changing the Page Format
  1196. To change the length of the page, use the command
  1197. .DS I 6
  1198. .BS
  1199. \&.PL paperlength [textlength [top offset]]
  1200. .BE
  1201. .DE
  1202. .UW ( P age
  1203. .UW L ength).
  1204. The operand
  1205. .B paperlength
  1206. determines the physical length of the page (the number of lines
  1207. which fit on one sheet of paper);
  1208. the operand
  1209. .B textlength
  1210. determines the number of lines used by PUBMAC (excluding top and bottom margin)
  1211. for text output.
  1212. If
  1213. .B textlength
  1214. is not specified it is defaulted to
  1215. .BW 26.03cm .
  1216. The default value for
  1217. .B paperlength
  1218. is 29.7cm, which is
  1219. the right value A4 paper.
  1220. .A
  1221. The offset of the text from the top of the paper is given by the operand
  1222. .B top offset
  1223. (default is 1.8cm).
  1224. The sum of
  1225. .B textlength
  1226. and
  1227. .B "top offset"
  1228. must be smaller then or equal to
  1229. .BW paperlength .
  1230. .A
  1231. This command must precede all other input text, as it is not
  1232. possible to change the page length during the text processing.
  1233. .P
  1234. To change the linelength, use the command
  1235. .DS I 6
  1236. .BS
  1237. \&.LL length [footnote length]
  1238. .BE
  1239. .DE
  1240. .UW ( L ine
  1241. .UW L ength).
  1242. The default line length 16.02cm.
  1243. The default footnote line length is 10/11 of the line length.
  1244. .S2 Head and Foot Titles
  1245. To define a head title, to appear at the start of each page, or to change
  1246. the standard foot title ("\-\-~%~\-\-") at the bottom of each page,
  1247. the commands
  1248. .DS I
  1249. .TS 0
  1250. l l.
  1251. \&.MS T define Top Margin titles
  1252. \&.MS B define Bottom Margin titles
  1253. \&.ME Title End
  1254. .TE 0
  1255. .DE
  1256. are supplied.
  1257. As with NROFF/TROFF, the current page number is represented by "%" in the
  1258. .B .TL
  1259. request.
  1260. .P
  1261. To define a head title, use the command
  1262. .DS I 6
  1263. .BS
  1264. \&.MS T [E/O] [count]
  1265. .BE
  1266. .DE
  1267. .UW ( M argin
  1268. .UW T op text).
  1269. The first optional operand allows the definition of different
  1270. titles for even and odd numbered pages;
  1271. specify
  1272. .B E
  1273. for titles to appear on even numbered, and
  1274. .B O
  1275. for titles to appear on odd numbered pages.
  1276. If the second operand is omitted, the title defined will
  1277. appear on all pages, regardless whether the page number
  1278. is even or odd.
  1279. The operand
  1280. .B count
  1281. specifies the number of blank lines between the top margin text
  1282. and the start of further text
  1283. (default 2).
  1284. .A
  1285. The text defining the head title
  1286. follows on the next input lines. If you want to enter PUBMAC
  1287. commands into the title which have to be executed each time the
  1288. head title is processed (e.g.
  1289. .B .TL
  1290. commands), precede the command lines with the character
  1291. sequence "\e!".
  1292. Commands that affect the general layout,
  1293. like
  1294. .BW .SS
  1295. and
  1296. .BW .IN ,
  1297. should be used with care.
  1298. In general it is wise to reset the altered environment to its
  1299. original state at the end of the title definition.
  1300. .P
  1301. To terminate the title definition, use
  1302. .DS I 6
  1303. .BS
  1304. \&.ME
  1305. .BE
  1306. .DE
  1307. .UW ( M argin
  1308. text
  1309. .UW E nd).
  1310. .P
  1311. Equivalent to head titles, foot titles can be defined. Use
  1312. .DS I 6
  1313. .BS
  1314. \&.MS B [E/O] [count]
  1315. .BE
  1316. .DE
  1317. .UW ( M argin
  1318. .UW B ottom
  1319. text) to start the input of the foot title. Use
  1320. the command
  1321. .B .ME
  1322. to terminate the foot title definition, too.
  1323. .P
  1324. The foot titles of this manual, for instance, have been
  1325. defined by:
  1326. .DS I 6
  1327. .BS
  1328. \&.MS B E
  1329. \&\e!.TL \'%\'\'\'
  1330. \&.ME
  1331. \&.MS B O
  1332. \&\e!.TL \'\'\'%\'
  1333. \&.ME
  1334. .BE
  1335. .DE
  1336. This example also shows the usage of the escape sequence
  1337. "\e!",
  1338. which prevents both
  1339. .B .TL
  1340. commands from being executed during the definition
  1341. of the titles, and causes them to be executed every time a new page
  1342. is processed.
  1343. This is essential to get the current page number
  1344. and not the page number being actual when the title is defined.
  1345. .NE 4
  1346. .P
  1347. To delete the standard foot title, simply define an empty foot title:
  1348. .DS I 6
  1349. .BS
  1350. \&.MS B 0
  1351. \&.ME
  1352. .BE
  1353. .DE
  1354. .S2 Setting the Standard Indentation
  1355. The value used for indenting paragraphs, after section start,
  1356. indented and quoted displays, and for the command
  1357. .B .IS,
  1358. by default is set to 3.
  1359. This value can be changed by invoking the command
  1360. .DS I 6
  1361. .BS
  1362. \&.IN [indent]
  1363. .BE
  1364. .DE
  1365. .UW ( IN dentation).
  1366. After this command, further sections, paragraphs etc. are indented by
  1367. the number of columns specified by
  1368. .BW indent .
  1369. If no indentation at all is desired, specify
  1370. .B 0
  1371. as operand.
  1372. .B Indent
  1373. has as default value 3.
  1374. .S2 "Page Number"
  1375. Sometimes a paper is formatted in parts.
  1376. The number of the first page of a certain part will not
  1377. always be 1.
  1378. The command
  1379. .DS I 6
  1380. .BS
  1381. \&.PN number [style]
  1382. .BE
  1383. .DE
  1384. .UW ( P age
  1385. .UW N umber)
  1386. allows you to use a different start value for page numbers.
  1387. The
  1388. .B style
  1389. operand
  1390. can have one of the values: a, A, i, I and 1.
  1391. These letters have the same meaning as for the
  1392. .B style
  1393. operand of the
  1394. .B .PS
  1395. request.
  1396. The new number ( and format ) becomes valid at the next printed page,
  1397. or at the first page if given before any text.
  1398. .S2 Adjusting
  1399. As already has been mentioned, the default mode for formatting
  1400. is filling and adjusting.
  1401. .A
  1402. Adjusting can be switched off
  1403. by the command
  1404. .DS I 6
  1405. .BS
  1406. \&.NA
  1407. .BE
  1408. .DE
  1409. .UW ( N o
  1410. .UW A djust).
  1411. All text following will not be aligned to a uniform right margin,
  1412. until a
  1413. .DS I 6
  1414. .BS
  1415. \&.AD [type]
  1416. .BE
  1417. .DE
  1418. .UW ( AD just)
  1419. is encountered, which switches on adjusting again.
  1420. The operand
  1421. .B type
  1422. can be one of the following,
  1423. .PS i 5
  1424. .PT "~~R"
  1425. Right adjusted: uniform right margin, ragged left margin
  1426. .PT "~~L"
  1427. Left adjusted: uniform left margin, ragged right margin
  1428. .PT "~~C"
  1429. Centered: both margins ragged by the same amount
  1430. .PT "~~B"
  1431. Both adjusted (default): uniform left and right margin
  1432. .PE
  1433. .S2 Hyphenation
  1434. Hyphenation can be switched off globally by using the command
  1435. .DS I 6
  1436. .BS
  1437. \&.NH
  1438. .BE
  1439. .DE
  1440. .UW ( N o
  1441. .UW H yphenation).
  1442. .NE 6
  1443. .N
  1444. The command
  1445. .DS I 6
  1446. .BS
  1447. \&.HY
  1448. .BE
  1449. .DE
  1450. .UW ( HY phenation)
  1451. enables hyphenation again.
  1452. .P
  1453. A second possibility is to use the command
  1454. .DS I 6
  1455. .BS
  1456. \&.HC character
  1457. .BE
  1458. .DE
  1459. (set
  1460. .UW H yphenation
  1461. .UW C haracter),
  1462. which determines the operand
  1463. .B character
  1464. to be the indicator character for hyphenation.
  1465. I.e. a word will be hyphenated
  1466. at the points indicated by this character.
  1467. The character itself will not appear in the
  1468. output, even if the word is not hyphenated.
  1469. Example:
  1470. .DS I 6
  1471. .BS
  1472. \&.HC `
  1473. \& .....
  1474. \& ... Algo`rithmus ...
  1475. .BE
  1476. .DE
  1477. This occurence of
  1478. .B Algorithmus
  1479. will now, if necessary, be hyphenated as
  1480. .BS
  1481. Algo-rithmus.
  1482. .BE
  1483. .A
  1484. To prevent a word to be hyphenated at all,
  1485. it has to be preceded by the hyphenation indicator character, e.g.
  1486. .BW `Algorithmus .
  1487. .S1 Footnotes, Table of Contents, Bibliography
  1488. PUBMAC provides commands for the creation of
  1489. footnotes, a table of contents and a list of bibliograpy.
  1490. .P
  1491. The following commands are available:
  1492. .DS I
  1493. .TS 0
  1494. l l.
  1495. \&.FS start a footnote
  1496. \&.FN start numbered footnote
  1497. \&.FE end a footnote
  1498. \&.CT put out the table of contents
  1499. \&.RS start a bibliography reference
  1500. \&.RF start a reference
  1501. \&.RE end a bibliography reference
  1502. \&.RT give list of bibliography
  1503. .TE 0
  1504. .DE
  1505. .S2 Footnotes
  1506. Three commands are provided to create a footnote.
  1507. Footnotes appear on the bottom of the page where they are
  1508. defined; if the remaining place on the page is too small
  1509. for the text of a footnote it will be shifted to the bottom of the next page.
  1510. .P
  1511. To start a footnote text, use the PUBMAC command
  1512. .DS I 6
  1513. .BS
  1514. \&.FS [prefix] indicator [ suffix ]
  1515. \&.FN [prefix] [suffix]
  1516. .BE
  1517. .DE
  1518. .UW ( F ootnote
  1519. .UW S tart,
  1520. .UW F ootnote
  1521. start
  1522. .UW N umbered).
  1523. .B indicator
  1524. allows to identify the footnote:
  1525. it will appear in the output text at the place where
  1526. .B .FS
  1527. was encountered in the input text, and it will appear at the start
  1528. of the footnote text.
  1529. .P
  1530. The
  1531. .B .FN
  1532. request has as default indicator a number.
  1533. This number is automaticaly incremented at each occurence of a
  1534. .B .FN
  1535. request.
  1536. The footnote counter is reset to one for each new section, when
  1537. in manual mode.
  1538. .A
  1539. The operand
  1540. .B suffix
  1541. is meant for the special case that
  1542. a full stop, comma, semicolon etc. immediately has to follow
  1543. the footnote indicator in the output text (otherwise the special
  1544. character and the indicator would be separated by a blank, or even worse,
  1545. by a newline).
  1546. The operand
  1547. .B prefix
  1548. serves a similar purpose.
  1549. .A
  1550. If only two of the three operands are specified, the last is
  1551. interpreted as the prefix.
  1552. .P
  1553. To end the text of a footnote, the command
  1554. .DS I 6
  1555. .BS
  1556. \&.FE
  1557. .BE
  1558. .DE
  1559. .UW ( F ootnote
  1560. .UW E nd)
  1561. is used. If the footnote is referenced in the middle of a sentence,
  1562. the rest of the sentence has to follow the
  1563. .B .FE
  1564. on the next line.
  1565. .NE 5
  1566. .P
  1567. As an example
  1568. .FS (*) ,
  1569. this is an example of a footnote
  1570. .FE
  1571. the footnote at the bottom of this page was created by the following
  1572. input lines:
  1573. .DS I 6
  1574. .BS
  1575. \&As an example
  1576. \&.FS (*) ,
  1577. \&this is an example of a footnote
  1578. \&.FE
  1579. \&the footnote at the .....
  1580. .BE
  1581. .DE
  1582. This example also shows the usage of the operand
  1583. .B suffix
  1584. of the
  1585. .B .FS
  1586. command, you see that the indicator "(*)"
  1587. is followed by "," immediately without a separating space.
  1588. .S2 Table of Contents
  1589. As mentioned above, all titles of sections are saved for a table
  1590. of contents.
  1591. To put out the table of contents,
  1592. at the end of the input text invoke the command
  1593. .DS I 6
  1594. .BS
  1595. \&.CT
  1596. .BE
  1597. .DE
  1598. .UW ( C ontents
  1599. .UW T able).
  1600. The table of contents collected up to now is put out and then deleted.
  1601. No headers or new page commands are generated.
  1602. This gives one the flexibility to put out the table of contents
  1603. for example at
  1604. the end of each chapter on a separate page or at the end of the
  1605. text in an appendix.
  1606. To have the pages on which the table of contents is printed, numbered
  1607. with roman numbers starting
  1608. with "i", use the command
  1609. .B .PN 1 i
  1610. before the
  1611. .B .CT
  1612. command.
  1613. The table of contents can then be inserted
  1614. before the front page of your paper instead of at the end.
  1615. In report mode the table of contents is also entered in the table of contents.
  1616. .S2 Bibliography
  1617. Besides supporting the
  1618. .U refer
  1619. utility PUBMAC provides
  1620. commands to collect literature references and
  1621. to print them at the desired place.
  1622. .A
  1623. To generate an entry in the bibliography and to refer to it, use
  1624. .DS I 6
  1625. .BS
  1626. \&.RS [prefix] refname [suffix]
  1627. .BE
  1628. .DE
  1629. .UW ( R eference
  1630. .UW S tart).
  1631. The text following this command is saved for the bibliography.
  1632. Similar to the operands of the footnote command ,
  1633. .B refname
  1634. is placed in the running output text and at the start of the
  1635. bibliography entry.
  1636. .B refname
  1637. will be enclosed in square brackets
  1638. (\ [ and\ ]\ ).
  1639. .B suffix
  1640. and
  1641. .B prefix
  1642. have the same meaning as with the footnote command.
  1643. PUBMAC commands for formatting the bibliography text have to be escaped
  1644. by "\e!", as the layout of the bibliography is determined
  1645. when the
  1646. .B .RT
  1647. command is invoked.
  1648. .P
  1649. .NE 8
  1650. If you want to create an entry without referring to it
  1651. in the text explicitely, use the command
  1652. .DS I 6
  1653. .BS
  1654. \&.RF refname
  1655. .BE
  1656. .DE
  1657. .UW ( R e F erence
  1658. start).
  1659. The result is the same as with
  1660. .B .RS,
  1661. but
  1662. .B refname
  1663. will not appear in the running text.
  1664. .P
  1665. To terminate a bibliography entry, use the command
  1666. .DS I 6
  1667. .BS
  1668. \&.RE
  1669. .BE
  1670. .DE
  1671. .UW ( R eference
  1672. entry
  1673. .UW E nd),
  1674. which will switch back to normal text
  1675. processing.
  1676. .P
  1677. To put out the collected bibliography, invoke the command
  1678. .DS I 6
  1679. .BS
  1680. \&.RT
  1681. .BE
  1682. .DE
  1683. .UW ( R eference
  1684. .UW T able).
  1685. The bibliography collected up to now is put out and then deleted,
  1686. so that it is possible to start a new bibliography.
  1687. In this way, bibliographies can be made either per section
  1688. or for the whole paper.
  1689. The bibliography is put out in the format being chosen the
  1690. point at which the
  1691. .B .RT
  1692. command is invoked.
  1693. .S2 Using refer
  1694. The program
  1695. .B refer
  1696. can be used to add references to articles mentioned in a
  1697. systemwide database, a private database or in the text.
  1698. It places an indicator in the text and the reference in a footnote
  1699. on the same page.
  1700. If the
  1701. .I \-e
  1702. option of
  1703. .B refer
  1704. is used the references will appear at the appropiate place.
  1705. The
  1706. collected references have to be surrounded by appropiate
  1707. PUBMAC commands.
  1708. .S2 Indeces
  1709. Commands are provided to collect index words accompanied by the number
  1710. of the page they occur.
  1711. Another command causes the list of collected index words to be printed
  1712. on NROFF/TROFF's error output.
  1713. .A
  1714. To add an index entry to the list use
  1715. .DS I 6
  1716. .BS
  1717. \&.IX index-word ...
  1718. \&.IW [prefix] index-word [suffix]
  1719. \&.IR index-word ...
  1720. .BE
  1721. .DE
  1722. The arguments of the
  1723. .B .IX
  1724. .UW ( I nde\c
  1725. .UW X )
  1726. and
  1727. .B .IW
  1728. .UW ( I ndex
  1729. .UW W ord)
  1730. commands appear in the running text,
  1731. as opposed to
  1732. .B .IR
  1733. .UW ( I ndex
  1734. .UW R ference)
  1735. whose arguments only appear in the index list.
  1736. .B Suffix
  1737. and
  1738. .B prefix
  1739. have the same meaning as with the footnote command.
  1740. .A 1
  1741. The collected references can be produced
  1742. on NROFF/TROFF's error output with the command
  1743. .DS I 6
  1744. .BS
  1745. \&.IT
  1746. .BE
  1747. .DE
  1748. .UW ( I ndex
  1749. .UW T able).
  1750. By redirecting the error output of NROFF/TROFF
  1751. one can save this list for further processing.
  1752. .DS I
  1753. .BS
  1754. troff -mkun files .... 2>indeces
  1755. awk -f .... indeces | troff -mkun
  1756. .BE
  1757. .DE
  1758. .A
  1759. The index entries are produced on one line each with the index words
  1760. enclosed in square brackets and
  1761. inmediatly followed by the appropiate page number.
  1762. An example:
  1763. .DS I 6
  1764. .BS
  1765. [indeces]\n%
  1766. .BE
  1767. .DE
  1768. .S1 Special Considerations
  1769. This section discusses
  1770. the use of the tabulator, special characters and some other special
  1771. facilities in PUBMAC.
  1772. .S2 Tabulator
  1773. The tabulator stops in PUBMAC are set to
  1774. .DS I 6
  1775. .BS
  1776. 9,17,25,33,....
  1777. .BE
  1778. .DE
  1779. by default.
  1780. To set the tabulator positions to your needs, use
  1781. .DS I 6
  1782. .BS
  1783. \&.ta pos...
  1784. .BE
  1785. .DE
  1786. (set
  1787. .UW TA bulator),
  1788. which will set the tabulator stops to the
  1789. positions indicated by
  1790. .B pos...
  1791. If pubmac is used in conjuction with
  1792. .B tbl
  1793. the tab stops will be heavily used by tbl and thereby rendered
  1794. almost unusable outside the tables.
  1795. .S2 Special characters
  1796. .SP
  1797. The character
  1798. "~"
  1799. is replaced by the unpaddable space character,
  1800. which permits tying two or more words together so that
  1801. they will neither be moved apart nor split across two lines.
  1802. For example, if you want the words
  1803. "integral number denotation" not to be separated by more
  1804. than one blank, enter them as
  1805. .BW integral~number~denotation .
  1806. .P
  1807. The command
  1808. .DS I 6
  1809. .BS
  1810. \&.SP [character]
  1811. .BE
  1812. .DE
  1813. allows you to use any other character as indicator for the unpaddable space.
  1814. If you specify no operand, you will have no single character to
  1815. indicate a unpaddable space.
  1816. .SP ~
  1817. .P
  1818. Since the backslash character "\e" is used heavily by NROFF/TROFF as escape
  1819. character,
  1820. it has to be written twice if one wants to see it back in the output.
  1821. As the text of displays is processed several times,
  1822. even a doubled backslash will be lost.
  1823. Therefore a backslash in a display should be entered
  1824. either eight or a higher power of 2 times (which is a nuisance) or as "\ee".
  1825. .S2 Halfline Motions
  1826. NROFF/TROFF, thus also PUBMAC, provides the
  1827. possibility for half line motions, e.g. for formatting
  1828. mathematical formulas.
  1829. The sequence
  1830. .B \ed
  1831. moves down half a line, and the sequence
  1832. .B \eu
  1833. moves up half a line.
  1834. The output
  1835. .N 1
  1836. (i\d1\u - i\d2\u)\u2\d
  1837. .N 1
  1838. was produced with the input
  1839. .DS I 6
  1840. .BS
  1841. (i\ed1\eu - i\ed2\eu)\eu2\ed
  1842. .BE
  1843. .DE
  1844. Usage of
  1845. .B \ed
  1846. and
  1847. .B \eu
  1848. can result in messy output on devices
  1849. not capable of performing half line motions; messy output
  1850. also will result if not the same number of "ups" and "downs" is
  1851. used.
  1852. .P
  1853. Typically lineprinters and display terminals can not perform half line
  1854. motions, whereas the HyPrint devices are capable of doing so.
  1855. .P
  1856. See also the section describing the use of
  1857. .B eqn
  1858. with PUBMAC.
  1859. .S2 The Actual Section Number
  1860. The actual section numbers are stored in registers named
  1861. .B Sn,
  1862. where
  1863. .B n
  1864. stands for any of the digits 1, 2, 3, 4 and 5.
  1865. If you want to refer to it, access it in the input text through
  1866. .B \en(Sn,
  1867. which will be replaced in the output text by the current section
  1868. number of the corresponding section depth.
  1869. For example if you wish to insert the number of the current chapter
  1870. use
  1871. .BW \en(S1 .
  1872. The register named S5 is used for the numbering of appendices.
  1873. .A
  1874. To use it in a page title definition, two backslashes have to be written:
  1875. .BW \e\en(Sn .
  1876. The first line of the page header of
  1877. this manual, for instance, has been produced by entering the
  1878. command
  1879. .DS I 6
  1880. .BS
  1881. \&\e!.TL \'PUBMAC users guide\'\'\e\en(S1\'
  1882. .BE
  1883. .DE
  1884. when defining the head title with the commands
  1885. .B .MS T
  1886. and
  1887. .B .ME
  1888. (see previous chapter).
  1889. .SM AP A
  1890. .AP "Error messages"
  1891. Besides error messages issued by NROFF/TROFF,
  1892. messages from PUBMAC may be written to the users terminal
  1893. (Unix error output file 2).
  1894. The messages have the following form:
  1895. .DS I 6
  1896. .BS
  1897. Error (p=.., l=..): message
  1898. .BE
  1899. .DE
  1900. .B message
  1901. gives information about the kind of error encountered.
  1902. The location of the error is described between the parentheses
  1903. in the order
  1904. .DS I
  1905. p = page number
  1906. l = line number on the page
  1907. .DE
  1908. Additionally, errors are marked by three plus signs (\(pl\(pl\(pl) or a \(lh
  1909. .DS I 6
  1910. .BS
  1911. \&\(lh Error
  1912. .BE
  1913. .DE
  1914. appearing on the right margin of the output text.
  1915. Since many errors are detected much too late,
  1916. the actual error is always located before the location stated.
  1917. .LL
  1918. .AP "Command Summary"
  1919. In the summary, the following abbreviations are used for operands:
  1920. .VS 0.8 0.2
  1921. .PS - 6
  1922. .PT n
  1923. denotes a number (e.g. '1', '5', '231')
  1924. .PT c
  1925. denotes a single character (e.g. 'i', 'F', 'O')
  1926. .PT w
  1927. denotes a word (e.g. 'NROFF', 'pubmac')
  1928. .PT w...
  1929. denotes a sequence of 1 or more words
  1930. (e.g. 'Table of Contents')
  1931. .PE
  1932. .VS
  1933. .N 4
  1934. .PS 1 14
  1935. .PT Command
  1936. Explanation
  1937. .PT .A [n]
  1938. .B Alinea.
  1939. .N
  1940. First line of alinea will be indented.
  1941. .N
  1942. The alinea will be preceded by n (default 0) blank lines.
  1943. .PT .AD [c]
  1944. .B Adjust mode.
  1945. .N
  1946. Left, Right, Centered or Both.
  1947. .NE 3+1
  1948. .PT ".AP w..."
  1949. .B Appendix.
  1950. .N
  1951. Same as .S1.
  1952. .NE 6+1
  1953. .PT ".B w..."
  1954. .B Boldface.
  1955. .N
  1956. Write the words given as operands w... in
  1957. bold face letters (this is done in a output device dependant way).
  1958. .PT .BE
  1959. .B Bold end.
  1960. .N
  1961. End of bolt text.
  1962. .PT .BP
  1963. .B Begin page.
  1964. .PT ".BS"
  1965. .B Bold start.
  1966. .N
  1967. All following text is printed in bold face up to .BE.
  1968. .N
  1969. The way bold face is printed depends on the output device.
  1970. .NE 10
  1971. .PT .CE
  1972. .B Centering end.
  1973. .N
  1974. The centered text will be followed by n blank lines.
  1975. .NE 3
  1976. .PT .CS
  1977. .B Centering start.
  1978. .N
  1979. Following input lines up to .CE will be centered.
  1980. .N
  1981. The centered text will be preceded by n blank lines.
  1982. .NE 10+1
  1983. .PT ".CT"
  1984. .B Table of contents.
  1985. .N
  1986. All titles collected from previous .S1, .S2, .S3, .S4 and .AP commands
  1987. are put out.
  1988. .PT ".CU w..."
  1989. .B Continuous underline.
  1990. .N
  1991. Like .U only all characters are underlined.
  1992. .NE 4+1
  1993. .PT .DB
  1994. .B Display break.
  1995. .N
  1996. Allow the following displays to be broken
  1997. up, if necessary.
  1998. .PT .DE [n]
  1999. .B Display end.
  2000. .N
  2001. The display will be followed by n (default 1) blank lines.
  2002. .NE 6+1
  2003. .PT ".DS "
  2004. .B Display.
  2005. .N
  2006. A display is text
  2007. which is kept together and not spread over a page boundary.
  2008. .N
  2009. The operands determine the kind of display.
  2010. The first few operands are:
  2011. .N
  2012. .PS - 4
  2013. .PT B
  2014. .B box display
  2015. .N
  2016. the text between .DS B and .DE
  2017. will be surrounded by a box, the text will be formatted and adjusted
  2018. .PT M
  2019. .B marked display
  2020. .N
  2021. the text will be marked by |
  2022. on the left hand side, not adjusted and not filled
  2023. .PT no
  2024. .N 1
  2025. not adjusted, not filled
  2026. .PE
  2027. These operands can be followed by:
  2028. .PS - 4
  2029. .PT I
  2030. .B indented display
  2031. .N
  2032. not adjusted, not filled
  2033. .PT Q
  2034. .B quoted display
  2035. .N
  2036. indented from both margins,
  2037. adjusted and filled
  2038. .PE
  2039. .PT .FE
  2040. .B Footnote end.
  2041. .NE 3
  2042. .PT ".FN [[w2] w1]"
  2043. .B Numbered footnote start
  2044. .N
  2045. As with .FS, but the indicator is defaulted to a number in parenthesis.
  2046. .NE 17+1
  2047. .PT ".FS [w3] w1 [w2]"
  2048. .B Footnote start.
  2049. .N
  2050. The footnote will be moved to the bottom of the page.
  2051. Operands: w1=indicator, w2=suffix and w3=prefix.
  2052. The indicator (w1) appears in the output text and
  2053. at the start of the footnote text as well to identify the footnote.
  2054. Prefix and suffix are for the special case that the indicator
  2055. has to be preceded or followed by e.g. comma, full stop etc.
  2056. The running text will contain w3w1w2.
  2057. .NE 10+1
  2058. .PT ".HC c"
  2059. .B Hyphenation character.
  2060. .N
  2061. The hyphenation control character is set to c.
  2062. It can be imbedded in words to indicate where they should be
  2063. hyphenated. If it precedes a word, this word will not be
  2064. hyphenated. The hyphenation character itself will not appear in
  2065. the output.
  2066. .PT .HY
  2067. .B Hyphenation.
  2068. .PT .IE
  2069. .B Indentation end.
  2070. .N
  2071. Return to the indentation level before the last .IS.
  2072. .NE 4+1
  2073. .PT ".IN n"
  2074. .B Set Indentation.
  2075. .N
  2076. The indentation used for paragraphs, section start etc
  2077. is set to n.
  2078. .NE 4+1
  2079. .PT .IR w...
  2080. .B Index Reference
  2081. add the words to the index list, do not
  2082. insert them in the running text.
  2083. .NE 4+1
  2084. .PT .IS [n]
  2085. .B Indentation start.
  2086. .N
  2087. Indent following text by n (default three) columns until
  2088. a .IE is encountered.
  2089. .NE 4+1
  2090. .PT .IT
  2091. .B Index Table
  2092. Produce the index table on file descriptor 2.
  2093. .NE 4+1
  2094. .PT .IW [w3] w1 [w2]
  2095. .B Index word
  2096. Insert w1, w2 and w3 in the running text as with
  2097. .B .FS
  2098. and add w1 to the index list.
  2099. .NE 4
  2100. .PT IX w...
  2101. .B Index
  2102. Insert the words in the running text and the index list.
  2103. .NE 5+1
  2104. .PT ".LL n"
  2105. .B Linelength.
  2106. .N
  2107. The line length is set to n.
  2108. The default line length is 66.
  2109. Must occur before any input text.
  2110. .NE 6+1
  2111. .PT .ME
  2112. .B Margin input end
  2113. .NE 13+1
  2114. .PT ".MS c1 c2"
  2115. .B Title input start.
  2116. .N
  2117. Operands: c1=T for T title, c1=B for bottom title,
  2118. c2=E for even pages, c2=O for odd pages.
  2119. The text between .MS and .ME will appear
  2120. as top and bottom margin text on each page.
  2121. Defaults: no top margin text, bottom margin text= ".TL \'\'-- % --\'\'".
  2122. Attention: NROFF/TROFF commands to be executed every time
  2123. (e.g. .TL \'\'-%-\'\')
  2124. a title is processed, have to be preceded by "\e!".
  2125. .PT ".N [n]"
  2126. .B New line.
  2127. .N
  2128. The new line will be preceded by n (default 0) blank lines.
  2129. .PT .NA
  2130. .B No adjust mode.
  2131. .N
  2132. The right margin will be ragged.
  2133. .NE 4+1
  2134. .PT ".NE n"
  2135. .B Need lines.
  2136. .N
  2137. If no n lines are left on the current page, a new page is begun.
  2138. .PT .NH
  2139. .B No hyphenation.
  2140. .NE 5+1
  2141. .PT ".P [n]"
  2142. .B Paragraph.
  2143. .N
  2144. The paragraph is separated from the preceding text
  2145. by n (default 1) blank lines and its first line is indented.
  2146. .PT .PE [n]
  2147. .B End list of points.
  2148. .NE 5+1
  2149. .N
  2150. The list will be followed by n (default 1) blank lines.
  2151. .NE 9+1
  2152. .PT ".PL n m"
  2153. .B Set pagelength.
  2154. .N
  2155. The first operand determines the physical length of the
  2156. page, the second one the number of lines printed per physical page.
  2157. The default value for n is 66, for m 59.
  2158. Must occur before any input text.
  2159. .PT ".PN n c"
  2160. .B Page number.
  2161. .N
  2162. The firts operand specifies the number of the next printed page.
  2163. The second operand specifies the format of the page number when printed.
  2164. (see .PS, but only a,A,i,I and 1).
  2165. .PT ".PO [n] "
  2166. .B Set page offset.
  2167. .N
  2168. The left margin is moved n columns to the
  2169. right.
  2170. .NE 12+1
  2171. .PT ".PS [c [n]] [[w2] w1]"
  2172. .B List of points start.
  2173. .N
  2174. Operands:
  2175. c=numbering style, n=indentation of points (default=3).
  2176. If c=- or empty, points are labeled with "-", if c=1
  2177. numbering of points will be arabic, if c=a with small letters,
  2178. if c=A with capital letters, if c=i with small roman numbers, if c=I
  2179. with capital roman numbers.
  2180. w1 is a suffix that will follow each point, w2 is a point prefix.
  2181. .NE 4+1
  2182. .PT ".PT w... "
  2183. .B Point.
  2184. .N
  2185. The operands w... replace the label chosen by .PS
  2186. for this point only.
  2187. .NE 4+1
  2188. .NE 2
  2189. .PT .RE
  2190. .B Reference entry end
  2191. .N
  2192. To close the text of the reference entry started by .RF or .RS.
  2193. .NE 12+1
  2194. .PT ".RF [w3] w1 [w2]"
  2195. .B Reference.
  2196. .N
  2197. Operands: w1=reference abbreviation,
  2198. w2=suffix, w3=prefix.(see .FS)
  2199. The reference abbreviation is embedded in square brackets
  2200. and inserted to the output text and to the start of the reference
  2201. entry as well for identification purposes.
  2202. References are collected to be put out
  2203. with .RT.
  2204. .PT .RP
  2205. .B Report layout.
  2206. .NE 4+1
  2207. .PT ".RS w"
  2208. .B Reference start.
  2209. .N
  2210. Same as .RF, but the reference w will not appear in the running output
  2211. text.
  2212. .NE 7+1
  2213. .PT .RT
  2214. .B Give bibliography.
  2215. .N
  2216. Via .RF and .RS collected bibliography is put out and then deleted.
  2217. .PT ".S1 w..."
  2218. .B Section.
  2219. .N
  2220. t is the section title, also saved for the table of contents.
  2221. Sections and subsections (see below) are numbered automatically.
  2222. .NE 5+1
  2223. .PT ".S2 w..."
  2224. .B Subsection.
  2225. .N
  2226. The title will be saved for the table of contents, as for
  2227. the following commands .S3 and .S4
  2228. .PT ".S3 w..."
  2229. .B Subsubsection.
  2230. .PT ".S4 w..."
  2231. .B Subsubsubsection.
  2232. .NE 6+1
  2233. .PT ".SN n n n n n"
  2234. .B Section numbers.
  2235. .N
  2236. The first, second, third and fourth operands
  2237. set the start values for section numbers, subsection numbers and so on.
  2238. The last operands sets the start value for the appendix number.
  2239. .NE 4+1
  2240. .PT ".ta n..."
  2241. .B Set tabulator.
  2242. .N
  2243. The tabulator stops are set to the positions n...
  2244. given in the operand list.
  2245. Usage conflicts with use of
  2246. .B tbl.
  2247. .NE 4+1
  2248. .PT ".TL x"
  2249. .B Title.
  2250. .N
  2251. To define a three part title; x is of the
  2252. form \'left\'center\'right\'.
  2253. .PT ".U w..."
  2254. .B Underline.
  2255. .N
  2256. The words given as operands w... are underlined.
  2257. .PT .UE
  2258. .B Underlining end.
  2259. .PT .UN
  2260. .B Undent temporarily.
  2261. .PT ".US [c]"
  2262. .B "Underlining start"
  2263. .N
  2264. All following text up to .UE is underlined.
  2265. Operand: c=C then the input text is non-filled and continuously underlined,
  2266. normaly only letters and digits are underlined.
  2267. .PE
  2268. .AP Bibliography
  2269. .N 2
  2270. .RT
  2271. .PN 1 A
  2272. .MS T E
  2273. \!.TL ```PUBMAC user's guide`
  2274. .ME
  2275. .MS T O
  2276. \!.TL `PUBMAC user's guide```
  2277. .ME
  2278. .BP
  2279. .N 0.5
  2280. .CS
  2281. Table of Contents
  2282. .CE
  2283. .N 1.5
  2284. .CT