eqn, grap, groff, pic, tbl, troff: add page (#6868)

beep
Gil Moskowitz 2021-10-21 03:17:15 -04:00 committed by GitHub
parent 99afbe2cf3
commit 318ca787e1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 74 additions and 26 deletions

13
pages/common/eqn.md Normal file
View File

@ -0,0 +1,13 @@
# eqn
> Equation preprocessor for the groff (GNU Troff) document formatting system.
> See also `troff` and `groff`.
> More information: <https://manned.org/eqn>.
- Process input with equations, saving the output for future typesetting with groff to PostScript:
`eqn {{path/to/input.eqn}} > {{path/to/output.roff}}`
- Typeset an input file with equations to PDF using the [me] macro package:
`eqn -T {{pdf}} {{path/to/input.eqn}} | groff -{{me}} -T {{pdf}} > {{path/to/output.pdf}}`

13
pages/common/grap.md Normal file
View File

@ -0,0 +1,13 @@
# grap
> A charting preprocessor for the groff (GNU Troff) document formatting system.
> See also `pic` and `groff`.
> More information: <https://manned.org/grap>.
- Process a `grap` file and save the output file for future processing with `pic` and `groff`:
`grap {{path/to/input.grap}} > {{path/to/output.pic}}`
- Typeset a `grap` file to PDF using the [me] macro package, saving the output to a file:
`grap {{path/to/input.grap}} | pic -T {{pdf}} | groff -{{me}} -T {{pdf}} > {{path/to/output.pdf}}`

View File

@ -1,25 +1,24 @@
# groff
> Typesetting program that reads plain text mixed with formatting commands and produces formatted output.
> It is the GNU replacement for the `troff` and `nroff` Unix commands for text formatting.
> GNU replacement for the `troff` and `nroff` typesetting utilities.
> More information: <https://www.gnu.org/software/groff>.
- Render a man page as plain text, and display the result:
- Format output for a PostScript printer, saving the output to a file:
`groff -man -T utf8 {{manpage.1}}`
`groff {{path/to/input.roff}} > {{path/to/output.ps}}`
- Render a man page using the ASCII output device, and display it using a pager:
`groff -man -T ascii {{manpage.1}} | less`
`groff -man -T ascii {{path/to/manpage.1}} | less`
- Render a man page into an HTML file:
`groff -man -T html {{manpage.1}} > {{page.html}}`
`groff -man -T html {{path/to/manpage.1}} > {{path/to/manpage.html}}`
- Process a roff file using the `tbl` and `pic` preprocessors, and the `me` macro set:
- Typeset a roff file containing [t]ables and [p]ictures, using the [me] macro set, to PDF, saving the output:
`groff -t -p -me -T utf8 {{foo.me}}`
`groff {{-t}} {{-p}} -{{me}} -T {{pdf}} {{path/to/input.me}} > {{path/to/output.pdf}}`
- Run a `groff` command with preprocessor and macro options guessed by the `grog` utility:
`eval "$(grog -T utf8 {{foo.me}})"`
`eval "$(grog -T utf8 {{path/to/input.me}})"`

13
pages/common/pic.md Normal file
View File

@ -0,0 +1,13 @@
# pic
> Picture preprocessor for the groff (GNU Troff) document formatting system.
> See also `groff` and `troff`.
> More information: <https://manned.org/pic>.
- Process input with pictures, saving the output for future typesetting with groff to PostScript:
`pic {{path/to/input.pic}} > {{path/to/output.roff}}`
- Typeset input with pictures to PDF using the [me] macro package:
`pic -T {{pdf}} {{path/to/input.pic}} | groff -{{me}} -T {{pdf}} > {{path/to/output.pdf}}`

View File

@ -1,24 +1,13 @@
# tbl
> Format tables for `troff`.
> Table preprocessor for the groff (GNU Troff) document formatting system.
> See also `groff` and `troff`.
> More information: <https://manned.org/tbl>.
- Format tables for `troff` and print it to stdout:
- Process input with tables, saving the output for future typesetting with groff to PostScript:
`cat {{path/to/file.troff}} | tbl`
`tbl {{path/to/input_file}} > {{path/to/output.roff}}`
- Format tables for `troff` in "compatibility mode":
- Typeset input with tables to PDF using the [me] macro package:
`cat {{path/to/file.troff}} | tbl -C`
- Format tables for `troff` from a file:
`tbl {{path/to/file.troff}}`
- Mark the beginning of a table ("Table Start"):
`.TS`
- Mark the end of the table ("Table End"):
`.TE`
`tbl -T {{pdf}} {{path/to/input.tbl}} | groff -{{me}} -T {{pdf}} > {{path/to/output.pdf}}`

21
pages/common/troff.md Normal file
View File

@ -0,0 +1,21 @@
# troff
> Typesetting processor for the groff (GNU Troff) document fomatting system.
> See also `groff`.
> More information: <https://manned.org/troff>.
- Format output for a PostScript printer, saving the output to a file:
`troff {{path/to/input.roff}} | grops > {{path/to/output.ps}}`
- Format output for a PostScript printer using the [me] macro package, saving the output to a file:
`troff -{{me}} {{path/to/input.roff}} | grops > {{path/to/output.ps}}`
- Format output as [a]SCII text using the [man] macro package:
`troff -T {{ascii}} -{{man}} {{path/to/input.roff}} | grotty`
- Format output as a [pdf] file, saving the output to a file:
`troff -T {{pdf}} {{path/to/input.roff}} | gropdf > {{path/to/output.pdf}}`