146 |
macro. |
macro. |
147 |
. |
. |
148 |
.LP |
.LP |
149 |
.ne 9 |
.ne 12 |
150 |
.B Margin settings |
.B Margin settings |
151 |
.RS |
.RS |
152 |
.na |
.na |
177 |
.RE |
.RE |
178 |
. |
. |
179 |
.LP |
.LP |
180 |
.ne 7 |
.ne 12 |
181 |
.B Text settings |
.B Text settings |
182 |
.RS |
.RS |
183 |
.TS |
.TS |
191 |
VS T{ |
VS T{ |
192 |
Line spacing (leading) |
Line spacing (leading) |
193 |
T} next para. 12p |
T} next para. 12p |
194 |
|
PSINCR T{ |
195 |
|
Point size increment |
196 |
|
for section headings of |
197 |
|
increasing importance |
198 |
|
T} next heading 1p |
199 |
|
GROWPS T{ |
200 |
|
Heading level |
201 |
|
beyond which PSINCR |
202 |
|
is ignored |
203 |
|
T} next heading 0 |
204 |
_ |
_ |
205 |
.TE |
.TE |
206 |
.RE |
.RE |
207 |
. |
. |
208 |
.LP |
.LP |
209 |
.ne 7 |
.ne 11 |
210 |
.B Paragraph settings |
.B Paragraph settings |
211 |
.RS |
.RS |
212 |
.TS |
.TS |
223 |
QI T{ |
QI T{ |
224 |
Quoted paragraph indent |
Quoted paragraph indent |
225 |
T} next para. 5n |
T} next para. 5n |
226 |
|
PORPHANS T{ |
227 |
|
Number of initial lines |
228 |
|
to be kept together |
229 |
|
T} next para. 1 |
230 |
|
HORPHANS T{ |
231 |
|
Number of initial lines |
232 |
|
to be kept with heading |
233 |
|
T} next heading 1 |
234 |
_ |
_ |
235 |
.TE |
.TE |
236 |
.RE |
.RE |
278 |
in the order shown. |
in the order shown. |
279 |
. |
. |
280 |
.TP |
.TP |
281 |
.B \&.RP [no] |
.B .RP [no] |
282 |
Specifies the report format for your document. |
Specifies the report format for your document. |
283 |
The report format creates a separate cover page. |
The report format creates a separate cover page. |
284 |
With no |
With no |
299 |
on page\~1 of the document. |
on page\~1 of the document. |
300 |
. |
. |
301 |
.TP |
.TP |
302 |
.B \&.P1 |
.B .P1 |
303 |
(P-one) Prints the header on page\~1. |
(P-one) Prints the header on page\~1. |
304 |
The default is to suppress the header. |
The default is to suppress the header. |
305 |
. |
. |
306 |
.TP |
.TP |
307 |
.BI "\&.DA [" xxx ] |
.BI ".DA [" xxx ] |
308 |
(optional) Print the current date, |
(optional) Print the current date, |
309 |
or the arguments to the macro if any, |
or the arguments to the macro if any, |
310 |
on the title page (if specified) |
on the title page (if specified) |
313 |
.IR nroff . |
.IR nroff . |
314 |
. |
. |
315 |
.TP |
.TP |
316 |
.BI "\&.ND [" xxx ] |
.BI ".ND [" xxx ] |
317 |
(optional) Print the current date, |
(optional) Print the current date, |
318 |
or the arguments to the macro if any, |
or the arguments to the macro if any, |
319 |
on the title page (if specified) |
on the title page (if specified) |
322 |
.IR troff . |
.IR troff . |
323 |
. |
. |
324 |
.TP |
.TP |
325 |
.B \&.TL |
.B .TL |
326 |
Specifies the document title. |
Specifies the document title. |
327 |
.I Groff |
.I Groff |
328 |
collects text following the |
collects text following the |
330 |
macro into the title, until reaching the author name or abstract. |
macro into the title, until reaching the author name or abstract. |
331 |
. |
. |
332 |
.TP |
.TP |
333 |
.B \&.AU |
.B .AU |
334 |
Specifies the author's name. |
Specifies the author's name. |
335 |
You can specify multiple authors by using an |
You can specify multiple authors by using an |
336 |
.B AU |
.B AU |
337 |
macro for each author. |
macro for each author. |
338 |
. |
. |
339 |
.TP |
.TP |
340 |
.B \&.AI |
.B .AI |
341 |
Specifies the author's institution. |
Specifies the author's institution. |
342 |
You can specify multiple institutions. |
You can specify multiple institutions. |
343 |
. |
. |
344 |
.TP |
.TP |
345 |
.B \&.AB [no] |
.B .AB [no] |
346 |
Begins the abstract. |
Begins the abstract. |
347 |
The default is to print the word |
The default is to print the word |
348 |
.BR ABSTRACT , |
.BR ABSTRACT , |
352 |
suppresses this heading. |
suppresses this heading. |
353 |
. |
. |
354 |
.TP |
.TP |
355 |
.B \&.AE |
.B .AE |
356 |
End the abstract. |
End the abstract. |
357 |
. |
. |
358 |
. |
. |
385 |
(the opposite of |
(the opposite of |
386 |
.BR PP ). |
.BR PP ). |
387 |
. |
. |
388 |
|
.PP |
389 |
|
For each of the above paragraph types, |
390 |
|
and also for any list entry introduced by the |
391 |
|
.B IP |
392 |
|
macro |
393 |
|
(described later), |
394 |
|
the document control register |
395 |
|
.BR PORPHANS , |
396 |
|
sets the |
397 |
|
.I minimum |
398 |
|
number of lines which must be printed, |
399 |
|
after the start of the paragraph, |
400 |
|
and before any page break occurs. |
401 |
|
If there is insufficient space remaining on the current page |
402 |
|
to accommodate this number of lines, |
403 |
|
then a page break is forced |
404 |
|
.I before |
405 |
|
the first line of the paragraph is printed. |
406 |
|
. |
407 |
|
.PP |
408 |
|
Similarly, |
409 |
|
when a section heading |
410 |
|
(see subsection |
411 |
|
.I Headings |
412 |
|
below) |
413 |
|
preceeds any of these paragraph types, |
414 |
|
the |
415 |
|
.B HORPHANS |
416 |
|
document control register specifies the |
417 |
|
.I minimum |
418 |
|
number of lines of the paragraph |
419 |
|
which must be kept on the same page as the heading. |
420 |
|
If insufficient space remains on the current page |
421 |
|
to accommodate the heading and this number of lines of paragraph text, |
422 |
|
then a page break is forced |
423 |
|
.I before |
424 |
|
the heading is printed. |
425 |
|
. |
426 |
. |
. |
427 |
.SS Headings |
.SS Headings |
428 |
. |
. |
429 |
Use headings to create a hierarchical structure |
Use headings to create a hierarchical structure |
430 |
for your document. |
for your document. |
431 |
The |
By default, |
432 |
|
the |
433 |
.I ms |
.I ms |
434 |
macros print headings in |
macros print headings in |
435 |
.B bold |
.B bold |
436 |
using the same font family and point size as the body text. |
using the same font family and point size as the body text. |
437 |
|
For output devices which support scalable fonts, |
438 |
|
this behaviour may be modified, |
439 |
|
by defining the document control registers, |
440 |
|
.B GROWPS |
441 |
|
and |
442 |
|
.BR PSINCR . |
443 |
. |
. |
444 |
.PP |
.PP |
445 |
The following heading macros are available: |
The following heading macros are available: |
446 |
. |
. |
447 |
.TP |
.TP |
448 |
.BI \&.NH \0xx |
.BI .NH\ xx |
449 |
Numbered heading. |
Numbered heading. |
450 |
The argument |
The argument |
451 |
.I xx |
.I xx |
462 |
.I groff |
.I groff |
463 |
prints a warning on standard error. |
prints a warning on standard error. |
464 |
. |
. |
465 |
|
.IP |
466 |
|
If the |
467 |
|
.B GROWPS |
468 |
|
register is set to a value |
469 |
|
greater than the level of the heading, |
470 |
|
then the point size of the heading will be increased by |
471 |
|
.B PSINCR |
472 |
|
units over the text size specified by the |
473 |
|
.B PS |
474 |
|
register, |
475 |
|
for each level by which the heading level is less than |
476 |
|
the value of |
477 |
|
.BR GROWPS . |
478 |
|
For example, |
479 |
|
the sequence: |
480 |
|
. |
481 |
|
.RS |
482 |
|
.ne 12 |
483 |
|
.nf |
484 |
|
.IP |
485 |
|
\&.nr PS 10 |
486 |
|
\&.nr GROWPS 3 |
487 |
|
\&.nr PSINCR 1.5p |
488 |
|
\&. |
489 |
|
\&.NH 1 |
490 |
|
Top Level Heading |
491 |
|
\&. |
492 |
|
\&.NH 2 |
493 |
|
Second Level Heading |
494 |
|
\&. |
495 |
|
\&.NH 3 |
496 |
|
Third Level Heading |
497 |
|
.fi |
498 |
|
.RE |
499 |
|
. |
500 |
|
.IP |
501 |
|
will cause |
502 |
|
.RI \*(lq 1.\ Top\ Level\ Heading \*(rq |
503 |
|
to be printed in 13pt |
504 |
|
.B bold |
505 |
|
text, followed by |
506 |
|
.RI \*(lq 1.1.\ Second\ Level\ Heading \*(rq |
507 |
|
in 11.5pt |
508 |
|
.B bold |
509 |
|
text, while |
510 |
|
.RI \*(lq 1.1.1.\ Third\ Level\ Heading \*(rq, |
511 |
|
and all more deeply nested heading levels, |
512 |
|
will remain in the 10pt |
513 |
|
.B bold |
514 |
|
text which is specified by the |
515 |
|
.B PS |
516 |
|
register. |
517 |
|
. |
518 |
|
.IP |
519 |
|
Note that the value stored in |
520 |
|
.B PSINCR |
521 |
|
is interpreted in |
522 |
|
.I groff |
523 |
|
basic units; |
524 |
|
the |
525 |
|
.I p |
526 |
|
scaling factor should be employed, |
527 |
|
when assigning a value specified in points. |
528 |
|
. |
529 |
|
.IP |
530 |
|
After invoking |
531 |
|
.BR .NH , |
532 |
|
the assigned heading number is available in the strings |
533 |
|
.B SN-DOT |
534 |
|
(exactly as it appears in the formatted heading), |
535 |
|
and |
536 |
|
.B SN-NO-DOT |
537 |
|
(with its final period omitted). |
538 |
|
The string |
539 |
|
.B SN |
540 |
|
is also defined, |
541 |
|
as an alias for |
542 |
|
.BR SN-DOT ; |
543 |
|
if preferred, |
544 |
|
the user may redefine it as an alias for |
545 |
|
.BR SN-NO-DOT , |
546 |
|
'ne 10 |
547 |
|
by including the initialisation: |
548 |
|
. |
549 |
|
.RS |
550 |
|
.nf |
551 |
|
.IP |
552 |
|
\&.ds SN-NO-DOT |
553 |
|
\&.als SN SN-NO-DOT |
554 |
|
.fi |
555 |
|
.RE |
556 |
|
. |
557 |
|
.IP |
558 |
|
.I before |
559 |
|
the first use of |
560 |
|
.BR .NH , |
561 |
|
or simply: |
562 |
|
. |
563 |
|
.RS |
564 |
|
.nf |
565 |
|
.IP |
566 |
|
\&.als SN SN-NO-DOT |
567 |
|
.fi |
568 |
|
.RE |
569 |
|
. |
570 |
|
.IP |
571 |
|
.I after |
572 |
|
the first use of |
573 |
|
.BR .NH . |
574 |
|
. |
575 |
.TP |
.TP |
576 |
.B \&.SH |
.BI .SH\ [ xx ] |
577 |
Unnumbered subheading. |
Unnumbered subheading. |
578 |
|
The use of the optional |
579 |
|
.I xx |
580 |
|
argument is a GNU extension, |
581 |
|
which adjusts the point size of the unnumbered subheading |
582 |
|
to match that of a numbered heading, |
583 |
|
introduced using |
584 |
|
.BI .NH\ xx |
585 |
|
with the same value of |
586 |
|
.IR xx . |
587 |
|
For example, |
588 |
|
given the same settings for |
589 |
|
.BR PS , |
590 |
|
.B GROWPS |
591 |
|
and |
592 |
|
.BR PSINCR , |
593 |
|
as used in the preceeding |
594 |
|
.B .NH |
595 |
|
example, |
596 |
|
the sequence: |
597 |
|
. |
598 |
|
.RS |
599 |
|
.ne |
600 |
|
.nf |
601 |
|
.IP |
602 |
|
\&.SH 2 |
603 |
|
An Unnumbered Subheading |
604 |
|
.fi |
605 |
|
.RE |
606 |
|
. |
607 |
|
.IP |
608 |
|
will print |
609 |
|
.RI \*(lq "An Unnumbered Subheading" \*(rq |
610 |
|
in 11.5pt |
611 |
|
.B bold |
612 |
|
text. |
613 |
. |
. |
614 |
. |
. |
615 |
.SS Highlighting |
.SS Highlighting |
620 |
or emphasize text: |
or emphasize text: |
621 |
. |
. |
622 |
.TP |
.TP |
623 |
.B "\&.B [\fItxt\fP [\fIpost\fP [\fIpre\fP]]]" |
.B ".B [\fItxt\fP [\fIpost\fP [\fIpre\fP]]]" |
624 |
Sets its first argument in |
Sets its first argument in |
625 |
.BR "bold type" . |
.BR "bold type" . |
626 |
If you specify a second argument, |
If you specify a second argument, |
652 |
the next highlighting, paragraph, or heading macro. |
the next highlighting, paragraph, or heading macro. |
653 |
. |
. |
654 |
.TP |
.TP |
655 |
.B "\&.R [\fItxt\fP [\fIpost\fP [\fIpre\fP]]]" |
.B ".R [\fItxt\fP [\fIpost\fP [\fIpre\fP]]]" |
656 |
Sets its first argument in |
Sets its first argument in |
657 |
roman (or regular) type. |
roman (or regular) type. |
658 |
It operates similarly to the |
It operates similarly to the |
660 |
macro otherwise. |
macro otherwise. |
661 |
. |
. |
662 |
.TP |
.TP |
663 |
.B "\&.I [\fItxt\fP [\fIpost\fP [\fIpre\fP]]]" |
.B ".I [\fItxt\fP [\fIpost\fP [\fIpre\fP]]]" |
664 |
Sets its first argument in |
Sets its first argument in |
665 |
.IR "italic type" . |
.IR "italic type" . |
666 |
It operates similarly to the |
It operates similarly to the |
668 |
macro otherwise. |
macro otherwise. |
669 |
. |
. |
670 |
.TP |
.TP |
671 |
.B "\&.CW [\fItxt\fP [\fIpost\fP [\fIpre\fP]]]" |
.B ".CW [\fItxt\fP [\fIpost\fP [\fIpre\fP]]]" |
672 |
Sets its first argument in a constant width face. |
Sets its first argument in a constant width face. |
673 |
It operates similarly to the |
It operates similarly to the |
674 |
.B B |
.B B |
675 |
macro otherwise. |
macro otherwise. |
676 |
. |
. |
677 |
.TP |
.TP |
678 |
.B "\&.BI [\fItxt\fP [\fIpost\fP [\fIpre\fP]]]" |
.B ".BI [\fItxt\fP [\fIpost\fP [\fIpre\fP]]]" |
679 |
Sets its first argument in bold italic type. |
Sets its first argument in bold italic type. |
680 |
It operates similarly to the |
It operates similarly to the |
681 |
.B B |
.B B |
682 |
macro otherwise. |
macro otherwise. |
683 |
. |
. |
684 |
.TP |
.TP |
685 |
.BI "\&.BX [" txt ] |
.BI ".BX [" txt ] |
686 |
Prints its argument and draws a box around it. |
Prints its argument and draws a box around it. |
687 |
If you want to box a string that contains spaces, |
If you want to box a string that contains spaces, |
688 |
use a digit-width space (\[rs]0). |
use a digit-width space (\[rs]0). |
689 |
. |
. |
690 |
.TP |
.TP |
691 |
.BI "\&.UL [" txt " [" post ]] |
.BI ".UL [" txt " [" post ]] |
692 |
Prints its first argument with an underline. |
Prints its first argument with an underline. |
693 |
If you specify a second argument, |
If you specify a second argument, |
694 |
.I groff |
.I groff |
696 |
the underlined text, with no intervening space. |
the underlined text, with no intervening space. |
697 |
. |
. |
698 |
.TP |
.TP |
699 |
.B \&.LG |
.B .LG |
700 |
Prints all text following in larger type |
Prints all text following in larger type |
701 |
(2\~points larger than the current point size) until |
(2\~points larger than the current point size) until |
702 |
the next font size, highlighting, paragraph, or heading macro. |
the next font size, highlighting, paragraph, or heading macro. |
704 |
to enlarge the point size as needed. |
to enlarge the point size as needed. |
705 |
. |
. |
706 |
.TP |
.TP |
707 |
.B \&.SM |
.B .SM |
708 |
Prints all text following in |
Prints all text following in |
709 |
smaller type |
smaller type |
710 |
(2\~points smaller than the current point size) until |
(2\~points smaller than the current point size) until |
713 |
to reduce the point size as needed. |
to reduce the point size as needed. |
714 |
. |
. |
715 |
.TP |
.TP |
716 |
.B \&.NL |
.B .NL |
717 |
Prints all text following in |
Prints all text following in |
718 |
the normal point size |
the normal point size |
719 |
(that is, the value of the |
(that is, the value of the |
905 |
in pairs of tags as follows: |
in pairs of tags as follows: |
906 |
. |
. |
907 |
.TP |
.TP |
908 |
.BR "\&.TS [H]" " and " \&.TE |
.BR ".TS [H]" " and " .TE |
909 |
Denotes a table, to be processed by the |
Denotes a table, to be processed by the |
910 |
.I tbl |
.I tbl |
911 |
preprocessor. |
preprocessor. |
924 |
prints the header on the next page as well. |
prints the header on the next page as well. |
925 |
. |
. |
926 |
.TP |
.TP |
927 |
.BR \&.PS " and " \&.PE |
.BR .PS " and " .PE |
928 |
Denotes a graphic, to be processed by the |
Denotes a graphic, to be processed by the |
929 |
.I pic |
.I pic |
930 |
preprocessor. |
preprocessor. |
938 |
.IR xfig . |
.IR xfig . |
939 |
. |
. |
940 |
.TP |
.TP |
941 |
.BR "\&.EQ [\fI\,align\/\fP]" " and " \&.EN |
.BR ".EQ [\fI\,align\/\fP]" " and " .EN |
942 |
Denotes an equation, to be processed by the |
Denotes an equation, to be processed by the |
943 |
.I eqn |
.I eqn |
944 |
preprocessor. |
preprocessor. |
953 |
the equation. |
the equation. |
954 |
. |
. |
955 |
.TP |
.TP |
956 |
.BR \&.[ " and " \&.] |
.BR .[ " and " .] |
957 |
Denotes a reference, to be processed by the |
Denotes a reference, to be processed by the |
958 |
.I refer |
.I refer |
959 |
preprocessor. |
preprocessor. |
1072 |
.RS |
.RS |
1073 |
. |
. |
1074 |
.IP |
.IP |
1075 |
.B "\&.OH '\fIleft\fP'\fIcenter\fP'\fIright\fP'" |
.B ".OH '\fIleft\fP'\fIcenter\fP'\fIright\fP'" |
1076 |
.RE |
.RE |
1077 |
. |
. |
1078 |
.IP |
.IP |
1133 |
force a page break. |
force a page break. |
1134 |
. |
. |
1135 |
.TP |
.TP |
1136 |
.B \&.1C |
.B .1C |
1137 |
Single-column mode. |
Single-column mode. |
1138 |
. |
. |
1139 |
.TP |
.TP |
1140 |
.B \&.2C |
.B .2C |
1141 |
Two-column mode. |
Two-column mode. |
1142 |
. |
. |
1143 |
.TP |
.TP |
1144 |
.BI "\&.MC [" width " [" gutter ]] |
.BI ".MC [" width " [" gutter ]] |
1145 |
Multi-column mode. |
Multi-column mode. |
1146 |
If you specify no arguments, it is equivalent to the |
If you specify no arguments, it is equivalent to the |
1147 |
.B 2C |
.B 2C |
1339 |
.I "groff ms" |
.I "groff ms" |
1340 |
should use this number register. |
should use this number register. |
1341 |
.br |
.br |
1342 |
.ne 22 |
.ne 23 |
1343 |
. |
. |
1344 |
. |
. |
1345 |
.SS Strings |
.SS Strings |