head 1.1; branch 1.1.1; access; symbols netbsd-10-1-RELEASE:1.1.1.1 perseant-exfatfs-base-20240630:1.1.1.1 perseant-exfatfs:1.1.1.1.0.28 perseant-exfatfs-base:1.1.1.1 netbsd-8-3-RELEASE:1.1.1.1 netbsd-9-4-RELEASE:1.1.1.1 netbsd-10-0-RELEASE:1.1.1.1 netbsd-10-0-RC6:1.1.1.1 netbsd-10-0-RC5:1.1.1.1 netbsd-10-0-RC4:1.1.1.1 netbsd-10-0-RC3:1.1.1.1 netbsd-10-0-RC2:1.1.1.1 netbsd-10-0-RC1:1.1.1.1 netbsd-10:1.1.1.1.0.26 netbsd-10-base:1.1.1.1 netbsd-9-3-RELEASE:1.1.1.1 cjep_sun2x-base1:1.1.1.1 cjep_sun2x:1.1.1.1.0.24 cjep_sun2x-base:1.1.1.1 cjep_staticlib_x-base1:1.1.1.1 netbsd-9-2-RELEASE:1.1.1.1 cjep_staticlib_x:1.1.1.1.0.22 cjep_staticlib_x-base:1.1.1.1 netbsd-9-1-RELEASE:1.1.1.1 phil-wifi-20200421:1.1.1.1 phil-wifi-20200411:1.1.1.1 is-mlppp:1.1.1.1.0.20 is-mlppp-base:1.1.1.1 phil-wifi-20200406:1.1.1.1 netbsd-8-2-RELEASE:1.1.1.1 netbsd-9-0-RELEASE:1.1.1.1 netbsd-9-0-RC2:1.1.1.1 netbsd-9-0-RC1:1.1.1.1 phil-wifi-20191119:1.1.1.1 netbsd-9:1.1.1.1.0.18 netbsd-9-base:1.1.1.1 phil-wifi-20190609:1.1.1.1 netbsd-8-1-RELEASE:1.1.1.1 netbsd-8-1-RC1:1.1.1.1 pgoyette-compat-merge-20190127:1.1.1.1 pgoyette-compat-20190127:1.1.1.1 pgoyette-compat-20190118:1.1.1.1 pgoyette-compat-1226:1.1.1.1 pgoyette-compat-1126:1.1.1.1 pgoyette-compat-1020:1.1.1.1 pgoyette-compat-0930:1.1.1.1 pgoyette-compat-0906:1.1.1.1 pgoyette-compat-0728:1.1.1.1 netbsd-8-0-RELEASE:1.1.1.1 phil-wifi:1.1.1.1.0.16 phil-wifi-base:1.1.1.1 pgoyette-compat-0625:1.1.1.1 netbsd-8-0-RC2:1.1.1.1 pgoyette-compat-0521:1.1.1.1 pgoyette-compat-0502:1.1.1.1 pgoyette-compat-0422:1.1.1.1 netbsd-8-0-RC1:1.1.1.1 pgoyette-compat-0415:1.1.1.1 pgoyette-compat-0407:1.1.1.1 pgoyette-compat-0330:1.1.1.1 pgoyette-compat-0322:1.1.1.1 pgoyette-compat-0315:1.1.1.1 pgoyette-compat:1.1.1.1.0.14 pgoyette-compat-base:1.1.1.1 matt-nb8-mediatek:1.1.1.1.0.12 matt-nb8-mediatek-base:1.1.1.1 perseant-stdc-iso10646:1.1.1.1.0.10 perseant-stdc-iso10646-base:1.1.1.1 netbsd-8:1.1.1.1.0.8 netbsd-8-base:1.1.1.1 prg-localcount2-base3:1.1.1.1 prg-localcount2-base2:1.1.1.1 prg-localcount2-base1:1.1.1.1 prg-localcount2:1.1.1.1.0.6 prg-localcount2-base:1.1.1.1 pgoyette-localcount-20170426:1.1.1.1 bouyer-socketcan-base1:1.1.1.1 pgoyette-localcount-20170320:1.1.1.1 bouyer-socketcan:1.1.1.1.0.4 bouyer-socketcan-base:1.1.1.1 pgoyette-localcount-20170107:1.1.1.1 pgoyette-localcount-20161104:1.1.1.1 localcount-20160914:1.1.1.1 pgoyette-localcount-20160806:1.1.1.1 pgoyette-localcount-20160726:1.1.1.1 pgoyette-localcount:1.1.1.1.0.2 pgoyette-localcount-base:1.1.1.1 groff-1-19-2:1.1.1.1 FSF:1.1.1; locks; strict; comment @# @; 1.1 date 2016.01.13.18.41.46; author christos; state Exp; branches 1.1.1.1; next ; commitid 3IfWnJaO3ZAcMNQy; 1.1.1.1 date 2016.01.13.18.41.46; author christos; state Exp; branches; next ; commitid 3IfWnJaO3ZAcMNQy; desc @@ 1.1 log @Initial revision @ text @ Mom -- Quick reference guide Next   Prev   Back to Table of Contents

Quick reference guide

Once you know your way around mom, you may find this guide preferable to using the Table of Contents. It lists (I hope) all mom's user-space macros. The links point to references found elsewhere in the documentation.

NOTE: This guide uses tables extensively. Better make sure you're reading it in a browser that renders them sensibly.

Typesetting Document processing
Page/paper size; margins; line length Reference macros
Family/font; pointsize; leading Letters
Font modifications Document style
Underscoring and underlining Special to PRINTSTYLE TYPEWRITE
Colour Begin document processing
Quad, justification and fill Customizing the document header
Line termination Pagination
Hyphenation Recto/verso
Word and sentence spacing Automatic columns
Kerning; ligatures Epigraphs
Vertical movements Heads
Horizontal movements Subheads
Indents Paragraph heads
Tabs Paragraphs
Manual columns Quotes
Superscripts Blockquotes
Dropcaps Author linebreaks
Lists Footnotes
Padding lines Endnotes
Miscellaneous Designing endnotes pages
  Lists
  Margin notes
  Line numbering
  References
  Bibliographies
  Table of contents
  Designing a table of contents
  Finis
  Headers and footers
  Part-by-part control
of headers
  Footers
  Covers and doc covers
  Customizing covers
and doc covers
  Part-by-part control of
covers and doc covers
  Miscellaneous

Typesetting macros

Page/paper size; margins; line length
Page/paper size Margins Line length
PAGEWIDTH T_MARGIN LL
PAGELENGTH B_MARGIN  
PAPER L_MARGIN  
PAGE R_MARGIN  

Family/font; pointsize; leading

Family/font Point size Leading
FAMILY PT_SIZE LS
FT \*[SIZE n] AUTOLEAD
FALLBACK_FONT    

Font modifications (pseudo-italic, -bold, -condensed, -extended)

Italicize Embolden Condense Extend
SETSLANT SETBOLDER CONDENSE EXTEND
\*[SLANT] \*[BOLDER] \*[COND] \*[EXT]
\*[SLANTX] \*[BOLDERX] \*[CONDX] \*[EXTX]

Underscoring and underlining

Underscore Underline
UNDERSCORE UNDERLINE
UNDERSCORE_2 \*[UL]...\*[ULX]

Colour

Define colours Invoke colours
NEWCOLOR COLOR
XCOLOR \*[<colorname>]

Quad, justification and fill

Fill modes No-fill modes
JUSTIFY LEFT
QUAD CENTER
  RIGHT

Line termination

Break Break (no space) Break (extra space) Break (force justify)
BR EL SPACE SPREAD

Hyphenation

Enable Set parameters
HY HY_SET

Word and sentence spacing

Word space Sentence space
WS SS

Character pair and full line kerning; ligatures

Kern character pairs Kern full lines Ligatures
KERN RW LIGATURES
\*[BU n] EW  
\*[FU n] BR_AT_LINE_KERN  

Vertical movements

Down Up
ALD RLD
\*[DOWN n] \*[UP n]

Horizontal movements

Forward Back
\*[FWD n] \*[BCK n]

Indents

Left Right Both Quit Temp Hanging
IL IR IB IQ TI HI
ILX IRX IBX      

Tabs

Setup Invoking Quitting
TAB_SET TAB TQ
\*[STn]...\*[STnX] TN  
ST    

Manual columns

Initializing Returning to top Exiting
MCO MCR MCX

Superscripts

Superscript Condensed superscript Extended superscript
\*[SUP]...\*[SUPX] \*[CONDSUP]...\*[CONDSUPX] \*[EXTSUP]...\*[EXTSUPX]

Dropcaps

Invoking Dropcap control
DROPCAP DROPCAP_FAMILY
  DROPCAP_FONT
  DROPCAP_COLOR
  DROPCAP_ADJUST
  DROPCAP_GUTTER

Lists

Initializing Setting items List control
LIST ITEM SHIFT_LIST
    RESET_LIST
    PAD_LIST_DIGITS

Padding lines

Pad a line Change the pad marker
PAD PAD_MARKER

Miscellaneous

Newpage All caps Smartquotes Rules/leaders
NEWPAGE CAPS SMARTQUOTES \*[RULE]
      \*[LEADER]
      LEADER_CHARACTER

Change the escape character Suppress input Disable traps
ESC_CHAR COMMENT TRAP
  SILENT  

Document processing

Reference macros
Titles Authors Draft copies
TITLE AUTHOR DRAFT
SUBTITLE   REVISION
DOCTITLE   DRAFT_STRING
CHAPTER   REVISION_STRING

Letters
Headers Closing Control
DATE CLOSING NO_SUITE
FROM    
TO    
GREETING    

Document style
Basic style Style control*
COPYSTYLE DOC_LEFT_MARGIN
DOCTYPE DOC_RIGHT_MARGIN
PRINTSTYLE** DOC_LINE_LENGTH
  DOC_FAMILY
  DOC_PT_SIZE
  DOC_LEAD
  DOC_LEAD_ADJUST
  DOC_QUAD

*See the note Changing document-wide style parameters after START
**Absolutely required if you wish to use the document processing macros.

Special to PRINTSTYLE TYPEWRITE

Italic/underlining Quotes
UNDERLINE_ITALIC UNDERLINE_QUOTES
ITALIC_MEANS_ITALIC  
UNDERLINE_SLANT  
SLANT_MEANS_SLANT  

Begin document processing
Absolutely required in order to initialize document processing
START

Customizing the document header
Global Title Subtitle Chapter
DOCHEADER TITLE_FAMILY SUBTITLE_FAMILY CHAPTER_STRING
DOCHEADER_ADVANCE TITLE_FONT SUBTITLE_FONT CHAPTER_TITLE_FAMILY
DOCHEADER_FAMILY TITLE_SIZE SUBTITLE_SIZE CHAPTER_TITLE_FONT
DOCHEADER_COLOR TITLE_COLOR SUBTITLE_COLOR CHAPTER_TITLE_SIZE
      CHAPTER_TITLE_COLOR

Attribution Author Document type
ATTRIBUTE_STRING AUTHOR_FAMILY DOCTYPE_FAMILY
ATTRIBUTE_COLOR AUTHOR_FONT DOCTYPE_FONT
  AUTHOR_SIZE DOCTYPE_SIZE
  AUTHOR_COLOR DOCTYPE_COLOR

Pagination
Paginate Style control
PAGINATE PAGENUM_FAMILY
PAGENUMBER PAGENUM_FONT
PAGENUM_STYLE* PAGENUM_SIZE
PAGENUM_ON_FIRST_PAGE PAGENUM_COLOR
DRAFT_WITH_PAGENUMBER PAGENUM_POS
SUSPEND_PAGINATION PAGENUM_HYPHENS
RESTORE_PAGINATION  

*I.e. the "format" of page numbering (digits, roman numerals, letters)

Recto/verso

Enabling Controling User-defined page headers/footers
for alternating pages*
RECTO_VERSO SWITCH_HEADERS HEADER_RECTO
  SWITCH_FOOTERS* HEADER_VERSO
    FOOTER_RECTO*
    FOOTER_VERSO*

*Please note that most aspects of page header and footer control are treated identically. In the documentation, the descriptions of macros that control header and footer behaviour usually only mention "HEADER" or "HEADER_". Simply apply "FOOTER" or "FOOTER_" to the appropriate "HEADER" or "HEADER_"macros in order to enable their behaviour for footers.

Automatic columns

Enabling Controling
COLUMNS COL_NEXT
  COL_BREAK

Epigraphs
Macro Type-style control Other
EPIGRAPH EPIGRAPH_FAMILY EPIGRAPH_AUTOLEAD
  EPIGRAPH_FONT EPIGRAPH_QUAD
  EPIGRAPH_SIZE EPIGRAPH_INDENT
  EPIGRAPH_COLOR  

Heads
Macro Type-style control Other
HEAD HEAD_FAMILY HEAD_QUAD
  HEAD_FONT HEAD_CAPS
  HEAD_SIZE HEAD_UNDERLINE
  HEAD_COLOR HEAD_SPACE
    NUMBER_HEADS
    RESET_HEAD_NUMBER

Subheads
Macro Type-style control Other
SUBHEAD SUBHEAD_FAMILY SUBHEAD_QUAD
  SUBHEAD_FONT NUMBER_SUBHEADS
  SUBHEAD_SIZE RESET_SUBHEAD_NUMBER
    SUBHEAD_COLOR

Paragraph heads
Macro Type-style control Other
PARAHEAD PARAHEAD_FAMILY PARAHEAD_INDENT
  PARAHEAD_FONT NUMBER_PARAHEADS
  PARAHEAD_SIZE RESET_PARAHEAD_NUMBER
  PARAHEAD_COLOR  

Paragraphs
Macro Type-style control* Other
PP PP_FONT PARA_INDENT
    INDENT_FIRST_PARAS
    PARA_SPACE

*For an in-depth explanation of how to manage the type-style of paragraphs, much of which is normally established through the use of typesetting macros prior to START, see Paragraph control macros.

Quotes
(line-for-line cited text, e.g. poetry or code snippets)

Macro Type-style control Other
QUOTE QUOTE_FAMILY QUOTE_INDENT*
  QUOTE_FONT ALWAYS_FULLSPACE_QUOTES
  QUOTE_SIZE BREAK_QUOTE
  QUOTE_AUTOLEAD UNDERLINE_QUOTES
  QUOTE_COLOR  

*Note that the use of QUOTE_INDENT sets the indent for both QUOTE and BLOCKQUOTE.

Blockquotes
(formatted citations)

Macro Type-style control Other
BLOCKQUOTE BLOCKQUOTE_FAMILY BLOCKQUOTE_INDENT
  BLOCKQUOTE_FONT BLOCKQUOTE_QUAD
  BLOCKQUOTE_SIZE BREAK_BLOCKQUOTE
  BLOCKQUOTE_AUTOLEAD  
  BLOCKQUOTE_COLOR  

*Note that the use of BLOCKQUOTE_INDENT sets the indent for both BLOCKQUOTE and QUOTE.

Author linebreaks
(also called "scene" or "section" breaks)

Macro Type-style control Other
LINEBREAK LINEBREAK_COLOR LINEBREAK_CHAR

Footnotes
Macro Type-style control Other
FOOTNOTE* FOOTNOTE_FAMILY FOOTNOTE_AUTOLEAD
  FOOTNOTE_FONT FOOTNOTE_QUAD
  FOOTNOTE_SIZE FOOTNOTE_MARKERS
  FOOTNOTE_COLOR FOOTNOTE_MARKER_STYLE
    RESET_FOOTNOTE_NUMBER
    FOOTNOTE_RULE
    FOOTNOTE_RULE_ADJ
    FOOTNOTE_RULE_LENGTH
    FOOTNOTES_RUN_ON

*Indenting of footnotes is handled by arguments passed to FOOTNOTE.

Endnotes

Input endnotes Output endnotes pages
ENDNOTE ENDNOTES

Designing endnotes pages
(if you want to change the defaults)

Type-style control Endnotes page
title string* 		Document identification string**
ENDNOTE_FAMILY ENDNOTE_STRING ENDNOTE_TITLE
ENDNOTE_FONT ENDNOTE_STRING_FAMILY ENDNOTE_TITLE_FAMILY
ENDNOTE_LEAD ENDNOTE_STRING_FONT ENDNOTE_TITLE_FONT
ENDNOTE_PT_SIZE ENDNOTE_STRING_SIZE ENDNOTE_TITLE_SIZE
ENDNOTE_QUAD ENDNOTE_STRING_CAPS ENDNOTE_TITLE_QUAD
  ENDNOTE_STRING_UNDERSCORE ENDNOTE_TITLE_UNDERSCORE

*By default, "Endnotes", at the top of the first page of endnotes
**I.e. how each document in the endnotes for a collated document is identified (by default, the strings passed to the reference macro, .TITLE

Endnotes numbering Paragraph control Endnotes headers/footers
ENDNOTE_NUMBER_FAMILY ENDNOTE_PARA_INDENT ENDNOTES_ALLOWS_HEADERS
ENDNOTE_NUMBER_FONT ENDNOTE_PARA_SPACE ENDNOTES_HEADER_CENTER
ENDNOTE_NUMBER_SIZE   ENDNOTES_FOOTER_CENTER
ENDNOTE_NUMBERS_ALIGN_LEFT    
ENDNOTE_NUMBERS_ALIGN_RIGHT    

Endnotes page numbering Misc
ENDNOTES_FIRST_PAGENUMBER ENDNOTES_NO_COLUMNS
ENDNOTES_PAGENUM_STYLE* SINGLESPACE_ENDNOTES**
ENDNOTES_NO_FIRST_PAGENUM  

*I.e. the format of page numbering (digits, roman, letters)
**Applies to PRINTSTYLE TYPEWRITE only

Margin notes

Initialize Start
MN_INIT MN

Line numbering
Text Quotes Blockquotes
NUMBER_LINES NUMBER_QUOTE_LINES NUMBER_BLOCKQUOTE_LINES

References
Begin/end refs Footnote refs Endnote refs Embedded refs
REF FOOTNOTE_REFS ENDNOTE_REFS REF( / REF)
      REF( / REF)
      REF[ / REF]
      REF{ / REF}

Bibliographies
Start bibliography page Bibliography type
BIBLIOGRAPHY BIBLIOGRAPHY_TYPE

Table of contents
Generate General
type-style control 		TOC title string*
and style control
TOC TOC_FAMILY TOC_HEADER_STRING
  TOC_PT_SIZE TOC_HEADER_FAMILY
  TOC_LEAD TOC_HEADER_FONT
    TOC_HEADER_SIZE
    TOC_HEADER_QUAD

*By default, "Table of Contents"

Designing a table of contents
(if you want to change the defaults)

Title entries Head entries Subhead entries
TOC_TITLE_ENTRY TOC_HEAD_FAMILY TOC_SUBHEAD_FAMILY
TOC_APPENDS_AUTHOR TOC_HEAD_FONT TOC_SUBHEAD_FONT
TOC_TITLE_FAMILY TOC_HEAD_SIZE TOC_SUBHEAD_SIZE
TOC_TITLE_FONT TOC_HEAD_INDENT TOC_SUBHEAD_INDENT
TOC_TITLE_SIZE    
TOC_TITLE_INDENT    

Parahead entries Page number entries Pagination Misc
TOC_PARAHEAD_FAMILY TOC_PN_FAMILY PAGINATE_TOC TOC_RV_SWITCH
TOC_PARAHEAD_FONT TOC_PN_FONT TOC_PAGENUM_STYLE*  
TOC_PARAHEAD_SIZE TOC_PN_SIZE    
TOC_PARAHEAD_INDENT TOC_PADDING    

*I.e. the format of page numbering (digits, roman, letters)

Finis

Macro Type style control
FINIS FINIS_COLOR
FINIS_STRING  

Headers and footers

Mom treats all aspects of headers and footers identically. The only difference between the two is whether the information they contain appears at the top of the page or at the bottom. Consequently, in the following, substitute FOOTERS for HEADERS, and FOOTER_ for HEADER_ if you're hunting down how to do something with footers.

Macro Placement User-defined headers General
type-style control
HEADERS HEADER_MARGIN HEADER_RECTO HEADER_FAMILY
  HEADER_GAP HEADER_VERSO HEADER_SIZE
      HEADER_COLOR
      HEADER_PLAIN

Part-by-part control of headers

Left Center Right
HEADER_LEFT HEADER_CENTER HEADER_RIGHT
HEADER_LEFT_FAMILY HEADER_CENTER_FAMILY HEADER_RIGHT_FAMILY
HEADER_LEFT_FONT HEADER_CENTER_FONT HEADER_RIGHT_FONT
HEADER_LEFT_SIZE HEADER_CENTER_SIZE HEADER_RIGHT_SIZE
HEADER_LEFT_COLOR HEADER_CENTER_COLOR HEADER_RIGHT_COLOR
HEADER_LEFT_CAPS HEADER_CENTER_CAPS HEADER_RIGHT_CAPS
  HEADER_CENTER_PAD  

Separator rule Misc
HEADER_RULE REVISION_STRING
HEADER_RULE_GAP DRAFT_STRING
HEADER_RULE_COLOR  

Footers

This is the one exception to the "HEADER also means FOOTER" convention used throughout the documentation.
FOOTER_ON_FIRST_PAGE

Covers and doc covers

Covers Doc covers
COVER DOC_COVER
COVERS DOC_COVERS

Customizing covers and doc covers
Covers Doc covers
COVERTITLE DOC_COVERTITLE
COVER_ADVANCE DOC_COVER_ADVANCE
COVER_FAMILY DOC_COVER_FAMILY
COVER_LEAD DOC_COVER_LEAD

Part-by-part control of covers and doc covers

For part-by-part control of the family, font, size and color, please see
Control macros--changing the defaults for covers and document covers
Index of cover and doc cover control macros

Miscellaneous

Output a blank page Collate multiple
documents		 Get leading back
on track
BLANKPAGE COLLATE SHIM

Next   Prev   Top   Back to Table of Contents @ 1.1.1.1 log @Import groff 1.19.2 @ text @@