{ "content": [ { "type": "text", "text": "# groff_me(7) (man)\n\n**Summary:** groffme - “me” macro package for formatting documents with GNU roff\n\n**Synopsis:** groff -me [option ...] [input-file ...]\ngroff -m me [option ...] [input-file ...]\n\n## See Also\n\n- groff(1)\n- troff(1)\n- eqn(1)\n- grn(1)\n- pic(1)\n- refer(1)\n- tbl(1)\n\n## Section Outline\n\n- **NAME** (2 lines)\n- **SYNOPSIS** (4 lines)\n- **DESCRIPTION** (21 lines) — 1 subsections\n - Macro Reference (96 lines)\n- **FILES** (3 lines)\n- **NOTES** (5 lines)\n- **SEE ALSO** (18 lines)\n\n## Full Content\n\n### NAME\n\ngroffme - “me” macro package for formatting documents with GNU roff\n\n### SYNOPSIS\n\ngroff -me [option ...] [input-file ...]\n\ngroff -m me [option ...] [input-file ...]\n\n### DESCRIPTION\n\nThe me package of macro definitions for the roff language provides a convenient facility for\npreparing technical papers in various formats. This manual page describes the GNU version of\nthe me macros, which is part of the groff document formatting system. This version can be\nused with both GNU troff and Unix troff.\n\nMany roff requests are unsafe in conjunction with this package; however, the following re‐\nquests may be used with impunity after the first .pp:\n\n.bp begin new page\n.br break output line here\n.sp n insert n spacing lines\n.ls n (line spacing) n=1 single, n=2 double space\n.na no alignment of right margin\n.ce n center next n lines\n.ul n underline next n lines\n\nNote: In contrast to its behavior with other macro packages and “raw” roff, when using the me\npackage, the .sp request will not put space at the top of a page.\n\nOutput of the pic, eqn, refer, and tbl preprocessors is acceptable as input.\n\n#### Macro Reference\n\nNumeric arguments to macros are denoted with lowercase letters and string arguments with up‐\npercase. An optional macro argument such as x appears in brackets, [x]. Note that arguments\nto macros generally must be quoted if they contain whitespace. An exception is the argument\nto header and footer macros, which require some explanation. They take the form “c left c\nmiddle c right c”, with spaces added here for clarity. The strings left, middle, and right\ncorrespond to their page placement and can contain unprotected whitespace, but must not con‐\ntain the (non-space) character c, which delimits them. For brevity, the table presents\nheader and footer arguments as clcmcrc. Popular choices for c are the ASCII apostrophe “'”\nand the ASCII double quote “\"”.\n\nThis list is incomplete; some requests are too complex to summarize in a table, and some that\nare listed below accept additional arguments not shown. See the -me Reference Manual for in‐\nteresting details.\n\nRequest Initial Causes Explanation\nValue Break\n──────────────────────────────────────────────────────────────────────────────────────────────\n.(c - yes Begin centered block.\n.(d - no Begin delayed text.\n.(f - no Begin footnote.\n.(l - yes Begin list.\n.(q - yes Begin major quote.\n.(x [X] - no Begin item in index (named X).\n.(z - no Begin floating keep.\n.)c - yes End centered block.\n.)d - yes End delayed text.\n.)f - yes End footnote.\n.)l - yes End list.\n.)q - yes End major quote.\n.)x - yes End index item.\n\n.)z - yes End floating keep.\n.++ M [clcmcrc] - no Define paper section as M, which must be one of C (chap‐\nter), A (appendix), P (preliminary, i.e., front matter\nor table of contents), AB (abstract), B (bibliography),\nRC (chapters renumbered from page one each chapter), or\nRA (appendix renumbered from page one) (and set page\nheader to clcmcrc).\n.+c [T] - yes Begin chapter (or appendix, etc., as set by .++) (with\ntitle T).\n.1c 1 yes One-column format on a new page.\n.2c 1 yes Two-column format.\n.EN - yes Space after equation produced by eqn or neqn.\n.EQ [M [T]] - yes Begin displayed equation (with indentation M, which must\nbe one of C (centered, default), I (indented), or L\n(justified left) (and title T in right margin)).\n.GE - yes End gremlin picture.\n.GS - yes Begin gremlin picture.\n.PE - yes End pic picture.\n.PS - yes Begin pic picture.\n.TE - yes End tbl table.\n.TH - yes End heading of tbl table.\n.TS [H] - yes Begin tbl table; if H, table repeats heading on each\npage.\n.b [X [Y]] - no Print X in bold (appending Y in the previous font); if\nno arguments, switch to bold.\n.ba n 0 yes Augment the base indent (for regular text, like para‐\ngraphs) by n.\n.bc - yes Begin new column.\n.bi [X [Y]] - no Print X in bold italics (appending Y in the previous\nfont); if no arguments, switch to bold italics.\n.bu - yes Begin bulleted paragraph.\n.bx [X [Y]] - no Print X in a box (with Y appended). Renders reliably\nonly in no-fill mode.\n.ef clcmcrc \"\"\"\" no Set even-numbered page footer.\n.eh clcmcrc \"\"\"\" no Set even-numbered page header.\n.fo clcmcrc \"\"\"\" no Set page footer.\n.hx - no Suppress headers and footers on next page.\n.he clcmcrc \"\"\"\" no Set page header.\n.hl - yes Draw a horizontal line.\n.i [X [Y]] - no Print X in italics (appending Y in the previous font);\nif no arguments, switch to italics.\n.ip [X [n]] n=5n yes Start indented paragraph (with hanging tag X (and inden‐\ntation n)).\n.lp - yes Begin paragraph with first line flush left.\n.np 1 yes Start numbered paragraph.\n.of clcmcrc \"\"\"\" no Set odd-numbered page footer.\n.oh clcmcrc \"\"\"\" no Set odd-numbered page header.\n.pd - yes Print delayed text.\n.pp - yes Begin paragraph with indented first line.\n.r [X [Y]] - no Print X in roman (appending Y in the previous font); if\nno arguments, switch to roman.\n.re 0.5i no Reset tabs to default values.\n.sh [n [T]] n=1 yes Start numbered section; print section number (set to n\n(and title T)) in bold.\n.sk - no Leave the next page blank. Only one page is remembered\nahead.\n.sm X [Y] - no Print X in a smaller point size (appending Y at the pre‐\nvious size).\n.sz n 10p no Augment the point size by n points.\n.tp - yes Begin title page.\n.u X [Y] - no Underline X (appending Y without underlining). Renders\nreliably only in no-fill mode.\n.uh [T] - yes Start unnumbered section (and print title T in bold).\n.xp [X] - no Print index (named X).\n\n### FILES\n\n/usr/share/groff/1.22.4/tmac/me.tmac (a wrapper file for e.tmac)\n/usr/share/groff/1.22.4/tmac/e.tmac\n\n### NOTES\n\nEarly roff macro packages limited themselves to a single-letter namespace (mm, ms, mv, mn,\netc.). The “e” in “me” stands for “Eric P. Allman”, who wrote the macro package and the\noriginal technical papers documenting it while an undergraduate at the University of Califor‐\nnia.\n\n### SEE ALSO\n\ngroff(1), troff(1)\n\nTwo manuals are available in source and rendered form. On your system, they may be com‐\npressed and/or available in additional formats.\n\n/usr/share/doc/groff-base/meintro.me\n/usr/share/doc/groff-base/meintro.ps\nis Writing Papers with Groff Using -me, by Eric P. Allman and James Clark.\n\n/usr/share/doc/groff-base/meref.me\n/usr/share/doc/groff-base/meref.ps\nis the -me Reference Manual, by Eric P. Allman and James Clark.\n\nFor preprocessors supported by me, see eqn(1), grn(1), pic(1), refer(1), and tbl(1).\n\n\n\ngroff 1.22.4 23 March 2022 GROFFME(7)\n\n" } ], "structuredContent": { "command": "groff_me", "section": "7", "mode": "man", "summary": "groffme - “me” macro package for formatting documents with GNU roff", "synopsis": "groff -me [option ...] [input-file ...]\ngroff -m me [option ...] [input-file ...]", "flags": [], "examples": [], "see_also": [ { "name": "groff", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/groff/1/json" }, { "name": "troff", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/troff/1/json" }, { "name": "eqn", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/eqn/1/json" }, { "name": "grn", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/grn/1/json" }, { "name": "pic", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/pic/1/json" }, { "name": "refer", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/refer/1/json" }, { "name": "tbl", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/tbl/1/json" } ], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "SYNOPSIS", "lines": 4, "subsections": [] }, { "name": "DESCRIPTION", "lines": 21, "subsections": [ { "name": "Macro Reference", "lines": 96 } ] }, { "name": "FILES", "lines": 3, "subsections": [] }, { "name": "NOTES", "lines": 5, "subsections": [] }, { "name": "SEE ALSO", "lines": 18, "subsections": [] } ] } }