/contrib/groff/src/roff/groff/groff.man

https://bitbucket.org/freebsd/freebsd-head/ · Unknown · 1739 lines · 1733 code · 6 blank · 0 comment · 0 complexity · ed0b1a8350ab557c52c3e54905c2ed32 MD5 · raw file

  1. .ig
  2. groff.man
  3. Last update: 01 Jul 2005
  4. Copyright (C) 1989, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
  5. Rewritten in 2002 by Bernd Warken <bwarken@mayn.de>
  6. Permission is granted to copy, distribute and/or modify this document
  7. under the terms of the GNU Free Documentation License, Version 1.1 or
  8. any later version published by the Free Software Foundation; with the
  9. Invariant Sections being this .ig-section and AUTHOR, with no
  10. Front-Cover Texts, and with no Back-Cover Texts.
  11. A copy of the Free Documentation License is included as a file called
  12. FDL in the main directory of the groff source package.
  13. $FreeBSD$
  14. ..
  15. .
  16. .\" --------------------------------------------------------------------
  17. .\" Setup
  18. .\" --------------------------------------------------------------------
  19. .
  20. .do nr groff_C \n[.C]
  21. .cp 0
  22. .
  23. .mso www.tmac
  24. .
  25. .\" set adjust to both
  26. .ad b
  27. .
  28. .\" fonts of fixed length
  29. .
  30. .if n \{\
  31. . mso tty-char.tmac
  32. . ftr CR R
  33. . ftr CI I
  34. . ftr CB B
  35. .\}
  36. .
  37. .if '\*[.T]'dvi' \
  38. . ftr CB CW
  39. .
  40. .\" --------------------------------------------------------------------
  41. .\" String definitions
  42. .
  43. .ds @- "\-\"
  44. .ds @-- "\-\^\-\"
  45. .
  46. .ds Ellipsis .\|.\|.\"
  47. .
  48. .
  49. .\" --------------------------------------------------------------------
  50. .\" Begin of macro definitions
  51. .de c
  52. .\" this is like a comment request when escape mechanism is off
  53. ..
  54. .eo
  55. .
  56. .c --------------------------------------------------------------------
  57. .de TP+
  58. .br
  59. .ns
  60. .TP \$1
  61. ..
  62. .c --------------------------------------------------------------------
  63. .c Like TP, but if specified indent is more than half
  64. .c the current line-length - indent, use the default indent.
  65. .de Tp
  66. . ie \n[.$]=0:((0\$1)*2u>(\n.lu-\n(.iu)) .TP
  67. . el .TP "\$1"
  68. ..
  69. .c --------------------------------------------------------------------
  70. .de Text
  71. . nop \)\$*
  72. ..
  73. .c --------------------------------------------------------------------
  74. .de Synopsis
  75. . ds @arg1 \$1\"
  76. . nr @old_indent \n[.i]
  77. . ad l
  78. . in +\w'\f[B]\*[@arg1]\0'u
  79. . ti \n[@old_indent]u
  80. . B \*[@arg1]\0\c
  81. . rr @old_indent
  82. . rm @arg1
  83. ..
  84. .c --------------------------------------------------------------------
  85. .de EndSynopsis
  86. . ad
  87. . in
  88. ..
  89. .c --------------------------------------------------------------------
  90. .c ShortOpt[] (name [arg])
  91. .c
  92. .c short option in synopsis
  93. .c
  94. .de ShortOpt[]
  95. . if \n[.$]=0 \
  96. . return
  97. . ds @opt \$1\"
  98. . shift
  99. . ie \n[.$]=0 \
  100. . Text \f[R][\f[]\f[CB]\*[@-]\*[@opt]\f[]\f[R]]\f[]
  101. . el \
  102. . Text \f[R][\f[]\f[CB]\*[@-]\*[@opt]\~\f[]\f[I]\/\$*\f[]\f[R]]\f[]
  103. . rm @opt
  104. ..
  105. .c --------------------------------------------------------------------
  106. .c Option in synopsis (short option)
  107. .de SynOpt
  108. . if \n[.$]=0 \
  109. . return
  110. . ds @opt \$1\"
  111. . shift
  112. . ie \n[.$]=0 \
  113. . Text \f[R][\f[]\f[CB]\*[@-]\*[@opt]\f[]\f[R]]\f[]
  114. . el \
  115. . Text \f[R][\f[]\f[CB]\*[@-]\*[@opt]\~\f[]\f[I]\/\$*\f[]\f[R]]\f[]
  116. . rm @opt
  117. ..
  118. .c --------------------------------------------------------------------
  119. .c ShortOpt ([char [punct]])
  120. .c
  121. .c `-c' somewhere in the text
  122. .c second arg is punctuation
  123. .c
  124. .de ShortOpt
  125. . ds @opt \$1\"
  126. . shift
  127. . Text \f[CB]\*[@-]\*[@opt]\f[]\/\$*
  128. . rm @opt
  129. ..
  130. .c --------------------------------------------------------------------
  131. .c LongOpt ([name [punct]])
  132. .c
  133. .c `--name' somewhere in the text
  134. .c second arg is punctuation
  135. .c
  136. .de LongOpt
  137. . ds @opt \$1\"
  138. . shift
  139. . Text \f[CB]\*[@--]\f[]\f[B]\*[@opt]\f[]\/\$*
  140. . rm @opt
  141. ..
  142. .c --------------------------------------------------------------------
  143. .c OptDef (shortopt [longopt [argument]])
  144. .c
  145. .c option documentation
  146. .c args : `shortopt', `longopt' can be ""
  147. .c
  148. .de OptDef
  149. . ds @short
  150. . ds @long
  151. . ds @arg
  152. . if \n[.$]>=1 \{\
  153. . ds @arg1 "\$1\"
  154. . if !'\*[@arg1]'' \
  155. . ds @short "\f[CB]\*[@-]\*[@arg1]\f[]\"
  156. . if \n[.$]>=2 \{\
  157. . if !'\*[@short]'' \
  158. . as @short \f[CW]\0\f[]
  159. . ds @arg2 "\$2\"
  160. . if !'\*[@arg2]'' \
  161. . ds @long "\f[CB]\*[@--]\f[]\f[B]\*[@arg2]\f[]\"
  162. . if \n[.$]>=3 \{\
  163. . if !'\*[@long]'' \
  164. . as @long \|=\|\"
  165. . shift 2
  166. . ds @arg \f[I]\$*\"
  167. . \}
  168. . \}
  169. . \}
  170. . IP "\f[R]\*[@short]\*[@long]\*[@arg]\f[]"
  171. . rm @arg
  172. . rm @arg1
  173. . rm @arg2
  174. . rm @short
  175. . rm @long
  176. ..
  177. .c --------------------------------------------------------------------
  178. .c Continuation of an OptDef header.
  179. .de OptDef+
  180. . br
  181. . ns
  182. . OptDef \$@
  183. ..
  184. .c --------------------------------------------------------------------
  185. .c Environment variable
  186. .de EnvVar
  187. . SM
  188. . BR \%\$1 \$2
  189. ..
  190. .c --------------------------------------------------------------------
  191. .c a shell command line
  192. .de ShellCommand
  193. . nr @font \n[.f]
  194. . c replace argument separator by unbreakable space
  195. . ds @args \$1\""
  196. . shift
  197. . while (\n[.$]>0) \{\
  198. . ds @args \*[@args]\~\$1
  199. . shift
  200. . \}
  201. . br
  202. . ad l
  203. . nh
  204. . Text \f[I]sh#\h'1m'\f[P]\f[CR]\*[@args]\f[P]\&\"
  205. . ft R
  206. . ft P
  207. . hy
  208. . ad
  209. . ft \n[@font]
  210. . br
  211. . rr @font
  212. . rm @args
  213. ..
  214. .c --------------------------------------------------------------------
  215. .c `char or string'
  216. .de Quoted
  217. . ft CR
  218. . Text \[oq]\$*\[cq]
  219. . ft
  220. ..
  221. .c --------------------------------------------------------------------
  222. .c End of macro definitions
  223. .ec
  224. .
  225. .
  226. .\" --------------------------------------------------------------------
  227. .\" Title
  228. .\" --------------------------------------------------------------------
  229. .
  230. .TH GROFF @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
  231. .SH NAME
  232. groff \- front-end for the groff document formatting system
  233. .
  234. .
  235. .\" --------------------------------------------------------------------
  236. .SH SYNOPSIS
  237. .\" --------------------------------------------------------------------
  238. .
  239. .ad l
  240. .Synopsis groff
  241. .ShortOpt[] abcegilpstzCEGNRSUVXZ
  242. .ShortOpt[] d cs
  243. .ShortOpt[] f fam
  244. .ShortOpt[] F dir
  245. .ShortOpt[] I dir
  246. .ShortOpt[] L arg
  247. .ShortOpt[] m name
  248. .ShortOpt[] M dir
  249. .ShortOpt[] n num
  250. .ShortOpt[] o list
  251. .ShortOpt[] P arg
  252. .ShortOpt[] r cn
  253. .ShortOpt[] T dev
  254. .ShortOpt[] w name
  255. .ShortOpt[] W name
  256. .RI [ file
  257. .Text \*[Ellipsis]]
  258. .EndSynopsis
  259. .
  260. .Synopsis groff
  261. .ShortOpt h
  262. |
  263. .LongOpt help
  264. .EndSynopsis
  265. .
  266. .Synopsis groff
  267. .ShortOpt v
  268. |
  269. .LongOpt version
  270. .RI [ option
  271. .Text \*[Ellipsis]]
  272. .EndSynopsis
  273. .
  274. .P
  275. The command line is parsed according to the usual GNU convention.
  276. .
  277. The whitespace between a command line option and its argument is
  278. optional.
  279. .
  280. Options can be grouped behind a single
  281. .ShortOpt
  282. (minus character).
  283. .
  284. A filename of
  285. .ShortOpt
  286. (minus character) denotes the standard input.
  287. .
  288. .
  289. .\" --------------------------------------------------------------------
  290. .SH DESCRIPTION
  291. .\" --------------------------------------------------------------------
  292. .
  293. This document describes the
  294. .B groff
  295. program, the main front-end for the
  296. .I groff
  297. document formatting system.
  298. .
  299. The
  300. .I groff
  301. program and macro suite is the implementation of a
  302. .BR roff (@MAN7EXT@)
  303. system within the free software collection
  304. .URL http://\:www.gnu.org "GNU" .
  305. .
  306. The
  307. .I groff
  308. system has all features of the classical
  309. .IR roff ,
  310. but adds many extensions.
  311. .
  312. .P
  313. The
  314. .B groff
  315. program allows to control the whole
  316. .I groff
  317. system by command line options.
  318. .
  319. This is a great simplification in comparison to the classical case (which
  320. uses pipes only).
  321. .
  322. .
  323. .\" --------------------------------------------------------------------
  324. .SH OPTIONS
  325. .\" --------------------------------------------------------------------
  326. .
  327. As
  328. .B groff
  329. is a wrapper program for
  330. .B @g@troff
  331. both programs share a set of options.
  332. .
  333. But the
  334. .B groff
  335. program has some additional, native options and gives a new meaning to
  336. some
  337. .B @g@troff
  338. options.
  339. .
  340. On the other hand, not all
  341. .B @g@troff
  342. options can be fed into
  343. .BR groff .
  344. .
  345. .
  346. .\" --------------------------------------------------------------------
  347. .SS Native groff Options
  348. .\" --------------------------------------------------------------------
  349. .
  350. The following options either do not exist for
  351. .B @g@troff
  352. or are differently interpreted by
  353. .BR groff .
  354. .
  355. .
  356. .OptDef e
  357. Preprocess with
  358. .BR @g@eqn .
  359. .
  360. .
  361. .OptDef g
  362. Preprocess with
  363. .BR @g@grn .
  364. .
  365. .
  366. .OptDef G
  367. Preprocess with
  368. .BR grap .
  369. .
  370. .
  371. .OptDef h help
  372. Print a help message.
  373. .
  374. .
  375. .OptDef I "" dir
  376. This option may be used to specify a directory to search for
  377. files (both those on the command line and those named in
  378. .B \&.psbb
  379. and
  380. .B \&.so
  381. requests, and
  382. .B \eX'ps: import'
  383. and
  384. .B \eX'ps: file'
  385. escapes).
  386. The current directory is always searched first.
  387. This option may be specified more than once;
  388. the directories will be searched in the order specified.
  389. No directory search is performed for files specified using an absolute path.
  390. This option implies the
  391. .ShortOpt s
  392. option.
  393. .
  394. .
  395. .OptDef l
  396. Send the output to a spooler program for printing.
  397. .
  398. The command that should be used for this is specified by the
  399. .B print
  400. command in the device description file, see
  401. .BR \%groff_font (@MAN5EXT@).
  402. If this command is not present, the output is piped into the
  403. .BR lpr (1)
  404. program by default.
  405. .
  406. See options
  407. .ShortOpt L
  408. and
  409. .ShortOpt X .
  410. .
  411. .
  412. .OptDef L "" arg
  413. Pass
  414. .I arg
  415. to the spooler program.
  416. Several arguments should be passed with a separate
  417. .ShortOpt L
  418. option each.
  419. .
  420. Note that
  421. .B groff
  422. does not prepend
  423. .ShortOpt\" just a minus sign
  424. (a minus sign) to
  425. .I arg
  426. before passing it to the spooler program.
  427. .
  428. .
  429. .OptDef N
  430. Don't allow newlines within
  431. .I eqn
  432. delimiters.
  433. .
  434. This is the same as the
  435. .ShortOpt N
  436. option in
  437. .BR @g@eqn .
  438. .
  439. .
  440. .OptDef p
  441. Preprocess with
  442. .BR @g@pic .
  443. .
  444. .
  445. .OptDef P "" "\*[@-]option"
  446. .OptDef+ P "" "\*[@-]option \f[CB]\*[@-]P\f[] arg"
  447. Pass
  448. .I \*[@-]option
  449. or
  450. .I \*[@-]option arg
  451. to the postprocessor.
  452. .
  453. The option must be specified with the necessary preceding minus
  454. sign(s)
  455. .Quoted \*[@-]
  456. or
  457. .Quoted \*[@--]
  458. because groff does not prepend any dashes before passing it to the
  459. postprocessor.
  460. .
  461. For example, to pass a title to the \%gxditview postprocessor, the shell
  462. command
  463. .IP
  464. .ShellCommand groff \*[@-]X \*[@-]P \*[@-]title \*[@-]P 'groff it' \f[I]foo\f[]
  465. .IP
  466. is equivalent to
  467. .IP
  468. .ShellCommand groff \*[@-]X \*[@-]Z \f[I]foo\f[] | \
  469. gxditview \*[@-]title 'groff it' \*[@-]
  470. .
  471. .
  472. .OptDef R
  473. Preprocess with
  474. .BR @g@refer .
  475. .
  476. No mechanism is provided for passing arguments to
  477. .B @g@refer
  478. because most
  479. .B @g@refer
  480. options have equivalent language elements that can be specified within
  481. the document.
  482. .
  483. See
  484. .BR \%@g@refer (@MAN1EXT@)
  485. for more details.
  486. .
  487. .
  488. .OptDef s
  489. Preprocess with
  490. .BR @g@soelim .
  491. .
  492. .
  493. .OptDef S
  494. Safer mode.
  495. .
  496. Pass the
  497. .ShortOpt S
  498. option to
  499. .B @g@pic
  500. and disable the following
  501. .B @g@troff
  502. requests:
  503. .BR .open ,
  504. .BR .opena ,
  505. .BR .pso ,
  506. .BR .sy ,
  507. and
  508. .BR .pi .
  509. For security reasons, safer mode is enabled by default.
  510. .
  511. .
  512. .OptDef t
  513. Preprocess with
  514. .BR @g@tbl .
  515. .
  516. .
  517. .OptDef T "" dev
  518. Set output device to
  519. .IR dev .
  520. For this device,
  521. .B @g@troff
  522. generates the
  523. .I intermediate
  524. .IR output ;
  525. see
  526. .BR \%groff_out (@MAN5EXT@).
  527. .
  528. Then
  529. .B groff
  530. calls a postprocessor to convert
  531. .BR @g@troff 's
  532. .I intermediate output
  533. to its final format.
  534. .
  535. Real devices in
  536. .B groff
  537. are
  538. .
  539. .RS
  540. .RS
  541. .IP dvi
  542. TeX DVI format (postprocessor is
  543. .BR grodvi ).
  544. .IP html
  545. HTML output (preprocessors are
  546. .B @g@soelim
  547. and
  548. .BR \%pre-grohtml ,
  549. postprocessor is
  550. .BR \%post-grohtml ).
  551. .IP lbp
  552. Canon CAPSL printers (\%LBP-4 and \%LBP-8 series laser printers;
  553. postprocessor is
  554. .BR grolbp ).
  555. .IP lj4
  556. HP LaserJet4 compatible (or other PCL5 compatible) printers (postprocessor
  557. is
  558. .BR grolj4 ).
  559. .IP ps
  560. PostScript output (postprocessor is
  561. .BR grops ).
  562. .RE
  563. .RE
  564. .
  565. .IP
  566. For the following TTY output devices (postprocessor is always
  567. .BR grotty ),
  568. .ShortOpt T
  569. selects the output encoding:
  570. .RS
  571. .RS
  572. .IP ascii
  573. 7bit ASCII.
  574. .IP cp1047
  575. \%Latin-1 character set for EBCDIC hosts.
  576. .IP latin1
  577. ISO \%8859-1.
  578. .IP utf8
  579. Unicode character set in \%UTF-8 encoding.
  580. .RE
  581. .RE
  582. .
  583. .IP
  584. The following arguments select
  585. .B \%gxditview
  586. as the `postprocessor' (it is rather a viewing program):
  587. .
  588. .RS
  589. .RS
  590. .IP X75
  591. 75dpi resolution, 10pt document base font.
  592. .IP X75-12
  593. 75dpi resolution, 12pt document base font.
  594. .IP X100
  595. 100dpi resolution, 10pt document base font.
  596. .IP X100-12
  597. 100dpi resolution, 12pt document base font.
  598. .RE
  599. .RE
  600. .
  601. .IP
  602. The default device is
  603. .BR @DEVICE@ .
  604. .
  605. .
  606. .OptDef U
  607. Unsafe mode.
  608. .
  609. Reverts to the (old) unsafe behaviour; see option
  610. .ShortOpt S .
  611. .
  612. .
  613. .OptDef v version
  614. Output version information of
  615. .B groff
  616. and of all programs that are run by it; that is, the given command line
  617. is parsed in the usual way, passing
  618. .ShortOpt v
  619. to all subprograms.
  620. .
  621. .
  622. .OptDef V
  623. Output the pipeline that would be run by
  624. .BR groff
  625. (as a wrapper program) on the standard output, but do not execute it.
  626. If given more than once,
  627. the commands will be both printed on the standard error and run.
  628. .
  629. .
  630. .OptDef X
  631. Use
  632. .B \%gxditview
  633. instead of using the usual postprocessor to (pre)view a document.
  634. .
  635. The printing spooler behavior as outlined with options
  636. .ShortOpt l
  637. and
  638. .ShortOpt L
  639. is carried over to
  640. .BR \%gxditview (@MAN1EXT@)
  641. by determining an argument for the
  642. .B \*[@-]printCommand
  643. option of
  644. .BR \%gxditview (@MAN1EXT@).
  645. .
  646. This sets the default
  647. .B Print
  648. action and the corresponding menu entry to that value.
  649. .
  650. .ShortOpt X
  651. only produces good results with
  652. .ShortOpt Tps ,
  653. .ShortOpt TX75 ,
  654. .ShortOpt TX75-12 ,
  655. .ShortOpt TX100 ,
  656. and
  657. .ShortOpt TX100-12 .
  658. .
  659. The default resolution for previewing
  660. .ShortOpt Tps
  661. output is 75\|dpi; this can be changed by passing the
  662. .ShortOpt resolution
  663. option to
  664. .BR \%gxditview ,
  665. for example
  666. .
  667. .IP
  668. .ShellCommand groff \*[@-]X \*[@-]P\*[@-]resolution \*[@-]P100 \*[@-]man foo.1
  669. .
  670. .
  671. .OptDef z
  672. Suppress output generated by
  673. .BR @g@troff .
  674. Only error messages will be printed.
  675. .
  676. .
  677. .OptDef Z
  678. Print the
  679. .I groff intermediate output
  680. to standard output; see
  681. .BR \%groff_out (@MAN5EXT@).
  682. Normally
  683. .BR groff
  684. calls automatically a postprocessor.
  685. .
  686. With this option, the output of
  687. .B @g@troff
  688. for the device, the so-called
  689. .I intermediate output
  690. is issued without postprocessing.
  691. .
  692. .
  693. .\" --------------------------------------------------------------------
  694. .SS Transparent Options
  695. .\" --------------------------------------------------------------------
  696. .
  697. The following options are transparently handed over to the formatter
  698. program
  699. .B @g@troff
  700. that is called by groff subsequently.
  701. .
  702. These options are described in more detail in
  703. .BR @g@troff (@MAN1EXT@).
  704. .
  705. .OptDef a
  706. ascii approximation of output.
  707. .
  708. .OptDef b
  709. backtrace on error or warning.
  710. .
  711. .OptDef c
  712. disable color output.
  713. .
  714. Please consult the
  715. .BR \%grotty (@MAN1EXT@)
  716. man page for more details.
  717. .
  718. .OptDef C
  719. enable compatibility mode.
  720. .
  721. .OptDef d "" cs
  722. .OptDef+ d "" name=s
  723. define string.
  724. .
  725. .OptDef E
  726. disable
  727. .B @g@troff
  728. error messages.
  729. .
  730. .OptDef f "" fam
  731. set default font family.
  732. .
  733. .OptDef F "" dir
  734. set path for font DESC files.
  735. .
  736. .OptDef i
  737. process standard input after the specified input files.
  738. .
  739. .OptDef m "" name
  740. include macro file \f[I]name\f[]\f[B].tmac\f[] (or
  741. \f[B]tmac.\f[]\f[I]name\f[]); see also
  742. .BR \%groff_tmac (@MAN5EXT@).
  743. .
  744. .OptDef M "" dir
  745. path for macro files.
  746. .
  747. .OptDef n "" num
  748. number the first page
  749. .IR num .
  750. .
  751. .OptDef o "" list
  752. output only pages in
  753. .IR list .
  754. .
  755. .OptDef r "" cn
  756. .OptDef+ r "" name=n
  757. set number register.
  758. .
  759. .OptDef w "" name
  760. enable warning
  761. .IR name .
  762. .
  763. .OptDef W "" name
  764. disable warning
  765. .IR name .
  766. .
  767. .
  768. .\" --------------------------------------------------------------------
  769. .SH "USING GROFF"
  770. .\" --------------------------------------------------------------------
  771. .
  772. The
  773. .I groff system
  774. implements the infrastructure of classical roff; see
  775. .BR roff (@MAN7EXT@)
  776. for a survey on how a roff system works in general.
  777. .
  778. Due to the front-end programs available within the groff system, using
  779. .I groff
  780. is much easier than
  781. .IR "classical roff" .
  782. .
  783. This section gives an overview of the parts that constitute the groff
  784. system.
  785. .
  786. It complements
  787. .BR roff (@MAN7EXT@)
  788. with groff-specific features.
  789. .
  790. This section can be regarded as a guide to the documentation around
  791. the groff system.
  792. .
  793. .
  794. .\" --------------------------------------------------------------------
  795. .SS Paper Size
  796. .\" --------------------------------------------------------------------
  797. .
  798. The
  799. .I virtual
  800. paper size used by
  801. .B troff
  802. to format the input is controlled globally with the requests
  803. .BR .po ,
  804. .BR .pl ,
  805. and
  806. .BR .ll .
  807. See
  808. .BR groff_tmac (@MAN5EXT@)
  809. for the `papersize' macro package which provides a convenient interface.
  810. .
  811. .P
  812. The
  813. .I physical
  814. paper size, giving the actual dimensions of the paper sheets, is
  815. controlled by output devices like
  816. .BR grops
  817. with the command line options
  818. .B \-p
  819. and
  820. .BR \-l .
  821. See
  822. .BR groff_font (@MAN5EXT@)
  823. and the man pages of the output devices for more details.
  824. .B groff
  825. uses the command line option
  826. .B \-P
  827. to pass options to output devices; for example, the following selects
  828. A4 paper in landscape orientation for the PS device:
  829. .
  830. .RS
  831. .P
  832. groff -Tps -P-pa4 -P-l .\|.\|.
  833. .RE
  834. .
  835. .
  836. .\" --------------------------------------------------------------------
  837. .SS Front-ends
  838. .\" --------------------------------------------------------------------
  839. .
  840. The
  841. .B groff
  842. program is a wrapper around the
  843. .BR @g@troff (@MAN1EXT@)
  844. program.
  845. .
  846. It allows to specify the preprocessors by command line options and
  847. automatically runs the postprocessor that is appropriate for the
  848. selected device.
  849. .
  850. Doing so, the sometimes tedious piping mechanism of classical
  851. .BR roff (@MAN7EXT@)
  852. can be avoided.
  853. .
  854. .P
  855. The
  856. .BR grog (@MAN1EXT@)
  857. program can be used for guessing the correct groff command line to
  858. format a file.
  859. .
  860. .P
  861. The
  862. .BR \%groffer (@MAN1EXT@)
  863. program is an allround-viewer for groff files and man pages.
  864. .
  865. .
  866. .\" --------------------------------------------------------------------
  867. .SS Preprocessors
  868. .\" --------------------------------------------------------------------
  869. .
  870. The groff preprocessors are reimplementations of the classical
  871. preprocessors with moderate extensions.
  872. .
  873. The preprocessors distributed with the
  874. .I groff
  875. package are
  876. .
  877. .TP
  878. .BR @g@eqn (@MAN1EXT@)
  879. for mathematical formul\(ae,
  880. .TP
  881. .BR @g@grn (@MAN1EXT@)
  882. for including
  883. .BR gremlin (1)
  884. pictures,
  885. .TP
  886. .BR @g@pic (@MAN1EXT@)
  887. for drawing diagrams,
  888. .TP
  889. .BR \%@g@refer (@MAN1EXT@)
  890. for bibliographic references,
  891. .TP
  892. .BR \%@g@soelim (@MAN1EXT@)
  893. for including macro files from standard locations,
  894. .
  895. .P
  896. and
  897. .TP
  898. .BR @g@tbl (@MAN1EXT@)
  899. for tables.
  900. .
  901. .P
  902. Besides these, there are some internal preprocessors that are
  903. automatically run with some devices.
  904. .
  905. These aren't visible to the user.
  906. .
  907. .
  908. .\" --------------------------------------------------------------------
  909. .SS "Macro Packages"
  910. .\" --------------------------------------------------------------------
  911. .
  912. Macro packages can be included by option
  913. .ShortOpt m .
  914. .
  915. The groff system implements and extends all classical macro packages
  916. in a compatible way and adds some packages of its own.
  917. .
  918. Actually, the following macro packages come with
  919. .IR groff :
  920. .
  921. .TP
  922. .B man
  923. The traditional man page format; see
  924. .BR \%groff_man (@MAN7EXT@).
  925. It can be specified on the command line as
  926. .ShortOpt man
  927. or
  928. .ShortOpt m
  929. .BR man .
  930. .
  931. .TP
  932. .B mandoc
  933. The general package for man pages; it automatically recognizes
  934. whether the documents uses the
  935. .I man
  936. or the
  937. .I mdoc
  938. format and branches to the corresponding macro package.
  939. .
  940. It can be specified on the command line as
  941. .ShortOpt mandoc
  942. or
  943. .ShortOpt m
  944. .BR mandoc .
  945. .
  946. .TP
  947. .B mdoc
  948. The BSD-style man page format; see
  949. .BR \%groff_mdoc (@MAN7EXT@).
  950. It can be specified on the command line as
  951. .ShortOpt mdoc
  952. or
  953. .ShortOpt m
  954. .BR mdoc .
  955. .
  956. .TP
  957. .B me
  958. The classical
  959. .I me
  960. document format; see
  961. .BR \%groff_me (@MAN7EXT@).
  962. It can be specified on the command line as
  963. .ShortOpt me
  964. or
  965. .ShortOpt m
  966. .BR me .
  967. .
  968. .TP
  969. .B mm
  970. The classical
  971. .I mm
  972. document format; see
  973. .BR \%groff_mm (@MAN7EXT@).
  974. It can be specified on the command line as
  975. .ShortOpt mm
  976. or
  977. .ShortOpt m
  978. .BR mm .
  979. .
  980. .TP
  981. .B ms
  982. The classical
  983. .I ms
  984. document format; see
  985. .BR \%groff_ms (@MAN7EXT@).
  986. It can be specified on the command line as
  987. .ShortOpt ms
  988. or
  989. .ShortOpt m
  990. .BR ms .
  991. .
  992. .TP
  993. .B www
  994. HTML-like macros for inclusion in arbitrary groff documents; see
  995. .BR \%groff_www (@MAN7EXT@).
  996. .
  997. .P
  998. Details on the naming of macro files and their placement can be found
  999. in
  1000. .BR \%groff_tmac (@MAN5EXT@);
  1001. this man page also documents some other, minor auxiliary macro packages
  1002. not mentioned here.
  1003. .
  1004. .
  1005. .\" --------------------------------------------------------------------
  1006. .SS "Programming Language"
  1007. .\" --------------------------------------------------------------------
  1008. .
  1009. General concepts common to all roff programming languages are
  1010. described in
  1011. .BR roff (@MAN7EXT@).
  1012. .
  1013. .P
  1014. The groff extensions to the classical troff language are documented in
  1015. .BR \%groff_diff (@MAN7EXT@).
  1016. .
  1017. .P
  1018. The groff language as a whole is described in the (still incomplete)
  1019. .IR "groff info file" ;
  1020. a short (but complete) reference can be found in
  1021. .BR groff (@MAN7EXT@).
  1022. .
  1023. .
  1024. .\" --------------------------------------------------------------------
  1025. .SS Formatters
  1026. .\" --------------------------------------------------------------------
  1027. .
  1028. The central roff formatter within the groff system is
  1029. .BR @g@troff (@MAN1EXT@).
  1030. It provides the features of both the classical troff and nroff, as
  1031. well as the groff extensions.
  1032. .
  1033. The command line option
  1034. .ShortOpt C
  1035. switches
  1036. .B @g@troff
  1037. into
  1038. .I "compatibility mode"
  1039. which tries to emulate classical roff as much as possible.
  1040. .
  1041. .P
  1042. There is a shell script
  1043. .BR @g@nroff (@MAN1EXT@)
  1044. that emulates the behavior of classical nroff.
  1045. .
  1046. It tries to automatically select the proper output encoding, according to
  1047. the current locale.
  1048. .
  1049. .P
  1050. The formatter program generates
  1051. .IR "intermediate output" ;
  1052. see
  1053. .BR \%groff_out (@MAN7EXT@).
  1054. .
  1055. .
  1056. .\" --------------------------------------------------------------------
  1057. .SS Devices
  1058. .\" --------------------------------------------------------------------
  1059. .
  1060. In roff, the output targets are called
  1061. .IR devices .
  1062. A device can be a piece of hardware, e.g. a printer, or a software
  1063. file format.
  1064. .
  1065. A device is specified by the option
  1066. .ShortOpt T .
  1067. The groff devices are as follows.
  1068. .
  1069. .TP
  1070. .B ascii
  1071. Text output using the
  1072. .BR ascii (7)
  1073. character set.
  1074. .
  1075. .TP
  1076. .B cp1047
  1077. Text output using the EBCDIC code page IBM cp1047 (e.g. OS/390 Unix).
  1078. .
  1079. .TP
  1080. .B dvi
  1081. TeX DVI format.
  1082. .
  1083. .TP
  1084. .B html
  1085. HTML output.
  1086. .
  1087. .TP
  1088. .B latin1
  1089. Text output using the ISO \%Latin-1 (ISO \%8859-1) character set; see
  1090. .BR \%iso_8859_1 (7).
  1091. .
  1092. .TP
  1093. .B koi8-r
  1094. Text output using the Russian KOI8-R character set.
  1095. .
  1096. .TP
  1097. .B lbp
  1098. Output for Canon CAPSL printers (\%LBP-4 and \%LBP-8 series laser printers).
  1099. .
  1100. .TP
  1101. .B lj4
  1102. HP LaserJet4-compatible (or other PCL5-compatible) printers.
  1103. .
  1104. .TP
  1105. .B ps
  1106. PostScript output; suitable for printers and previewers like
  1107. .BR gv (1).
  1108. .
  1109. .TP
  1110. .B utf8
  1111. Text output using the Unicode (ISO 10646) character set with \%UTF-8
  1112. encoding; see
  1113. .BR unicode (7).
  1114. .
  1115. .TP
  1116. .B X75
  1117. 75dpi X Window System output suitable for the previewers
  1118. .BR \%xditview (1x)
  1119. and
  1120. .BR \%gxditview (@MAN1EXT@).
  1121. A variant for a 12\|pt document base font is
  1122. .BR \%X75-12 .
  1123. .
  1124. .TP
  1125. .B X100
  1126. 100dpi X Window System output suitable for the previewers
  1127. .BR \%xditview (1x)
  1128. and
  1129. .BR \%gxditview (@MAN1EXT@).
  1130. A variant for a 12\|pt document base font is
  1131. .BR \%X100-12 .
  1132. .
  1133. .P
  1134. The postprocessor to be used for a device is specified by the
  1135. .B postpro
  1136. command in the device description file; see
  1137. .BR \%groff_font (@MAN5EXT@).
  1138. .
  1139. This can be overridden with the
  1140. .B \*[@-]X
  1141. option.
  1142. .
  1143. .P
  1144. The default device is
  1145. .BR @DEVICE@ .
  1146. .
  1147. .
  1148. .\" --------------------------------------------------------------------
  1149. .SS Postprocessors
  1150. .\" --------------------------------------------------------------------
  1151. .
  1152. groff provides 3\~hardware postprocessors:
  1153. .
  1154. .TP
  1155. .BR \%grolbp (@MAN1EXT@)
  1156. for some Canon printers,
  1157. .TP
  1158. .BR \%grolj4 (@MAN1EXT@)
  1159. for printers compatible to the HP LaserJet\~4 and PCL5,
  1160. .TP
  1161. .BR \%grotty (@MAN1EXT@)
  1162. for text output using various encodings, e.g. on text-oriented
  1163. terminals or line-printers.
  1164. .
  1165. .P
  1166. Today, most printing or drawing hardware is handled by the operating
  1167. system, by device drivers, or by software interfaces, usually accepting
  1168. PostScript.
  1169. .
  1170. Consequently, there isn't an urgent need for more hardware device
  1171. postprocessors.
  1172. .
  1173. .P
  1174. The groff software devices for conversion into other document file
  1175. formats are
  1176. .
  1177. .TP
  1178. .BR \%grodvi (@MAN1EXT@)
  1179. for the DVI format,
  1180. .TP
  1181. .BR \%grohtml (@MAN1EXT@)
  1182. for HTML format,
  1183. .TP
  1184. .BR grops (@MAN1EXT@)
  1185. for PostScript.
  1186. .
  1187. .P
  1188. Combined with the many existing free conversion tools this should
  1189. be sufficient to convert a troff document into virtually any existing
  1190. data format.
  1191. .
  1192. .
  1193. .\" --------------------------------------------------------------------
  1194. .SS Utilities
  1195. .\" --------------------------------------------------------------------
  1196. .
  1197. The following utility programs around groff are available.
  1198. .
  1199. .TP
  1200. .BR \%addftinfo (@MAN1EXT@)
  1201. Add information to troff font description files for use with groff.
  1202. .
  1203. .TP
  1204. .BR \%afmtodit (@MAN1EXT@)
  1205. Create font description files for PostScript device.
  1206. .
  1207. .TP
  1208. .BR \%groffer (@MAN1EXT@)
  1209. General viewer program for groff files and man pages.
  1210. .
  1211. .TP
  1212. .BR \%gxditview (@MAN1EXT@)
  1213. The groff X viewer, the GNU version of xditview.
  1214. .
  1215. .TP
  1216. .BR \%hpftodit (@MAN1EXT@)
  1217. Create font description files for lj4 device.
  1218. .
  1219. .TP
  1220. .BR \%indxbib (@MAN1EXT@)
  1221. Make inverted index for bibliographic databases.
  1222. .
  1223. .TP
  1224. .BR lkbib (@MAN1EXT@)
  1225. Search bibliographic databases.
  1226. .
  1227. .TP
  1228. .BR \%lookbib (@MAN1EXT@)
  1229. Interactively search bibliographic databases.
  1230. .
  1231. .TP
  1232. .BR \%pfbtops (@MAN1EXT@)
  1233. Translate a PostScript font in .pfb format to ASCII.
  1234. .
  1235. .TP
  1236. .BR \%tfmtodit (@MAN1EXT@)
  1237. Create font description files for TeX DVI device.
  1238. .
  1239. .TP
  1240. .BR \%xditview (1x)
  1241. roff viewer distributed with X window.
  1242. .
  1243. .
  1244. .\" --------------------------------------------------------------------
  1245. .SH ENVIRONMENT
  1246. .\" --------------------------------------------------------------------
  1247. .
  1248. Normally, the path separator in the following environment variables is the
  1249. colon; this may vary depending on the operating system.
  1250. .
  1251. For example, DOS and Windows use a semicolon instead.
  1252. .
  1253. .TP
  1254. .EnvVar GROFF_BIN_PATH
  1255. This search path, followed by
  1256. .EnvVar $PATH ,
  1257. will be used for commands that are executed by
  1258. .BR groff .
  1259. .
  1260. If it is not set then the directory where the groff binaries were
  1261. installed is prepended to
  1262. .EnvVar PATH .
  1263. .
  1264. .TP
  1265. .EnvVar GROFF_COMMAND_PREFIX
  1266. When there is a need to run different roff implementations at the same
  1267. time
  1268. .I groff
  1269. provides the facility to prepend a prefix to most of its programs that
  1270. could provoke name clashings at run time (default is to have none).
  1271. .
  1272. Historically, this prefix was the character
  1273. .BR g ,
  1274. but it can be anything.
  1275. .
  1276. For example,
  1277. .BR gtroff
  1278. stood for
  1279. .IR groff 's
  1280. .BR troff ,
  1281. .BR gtbl
  1282. for the
  1283. .I groff
  1284. version of
  1285. .BR tbl .
  1286. .
  1287. By setting
  1288. .EnvVar GROFF_COMMAND_PREFIX
  1289. to different values, the different roff installations can be
  1290. addressed.
  1291. .
  1292. More exactly, if it is set to prefix
  1293. .I xxx
  1294. then
  1295. .B groff
  1296. as a wrapper program will internally call
  1297. .IB xxx troff
  1298. instead of
  1299. .BR troff .
  1300. This also applies to the preprocessors
  1301. .BR \%eqn ,
  1302. .BR \%grn ,
  1303. .BR \%pic ,
  1304. .BR \%refer ,
  1305. .BR \%tbl ,
  1306. .BR \%soelim ,
  1307. and to the utilities
  1308. .B \%@g@indxbib
  1309. and
  1310. .BR \%@g@lookbib .
  1311. .
  1312. This feature does not apply to any programs different from the ones
  1313. above (most notably
  1314. .B groff
  1315. itself) since they are unique to the groff package.
  1316. .
  1317. .
  1318. .TP
  1319. .EnvVar GROFF_FONT_PATH
  1320. A list of directories in which to search for the
  1321. .BI dev name
  1322. directory in addition to the default ones.
  1323. .
  1324. See
  1325. .BR @g@troff (@MAN1EXT@)
  1326. and
  1327. .BR \%groff_font (@MAN5EXT@)
  1328. for more details.
  1329. .
  1330. .
  1331. .TP
  1332. .EnvVar GROFF_TMAC_PATH
  1333. A list of directories in which to search for macro files in addition to
  1334. the default directories.
  1335. .
  1336. See
  1337. .BR @g@troff (@MAN1EXT@)
  1338. and
  1339. .BR \%groff_tmac (@MAN5EXT@)
  1340. for more details.
  1341. .
  1342. .
  1343. .TP
  1344. .EnvVar GROFF_TMPDIR
  1345. The directory in which temporary files will be created.
  1346. .
  1347. If this is not set but the environment variable
  1348. .EnvVar TMPDIR
  1349. instead, temporary files will be created in the directory
  1350. .EnvVar $TMPDIR .
  1351. On MS-DOS and Windows\ 32 platforms, the environment variables
  1352. .EnvVar TMP
  1353. and
  1354. .EnvVar TEMP
  1355. (in that order) are searched also, after
  1356. .EnvVar GROFF_TMPDIR
  1357. and
  1358. .EnvVar TMPDIR .
  1359. .
  1360. Otherwise, temporary files will be created in
  1361. .BR /tmp .
  1362. The
  1363. .BR \%@g@refer (@MAN1EXT@),
  1364. .BR \%groffer (@MAN1EXT@),
  1365. .BR \%grohtml (@MAN1EXT@),
  1366. and
  1367. .BR grops (@MAN1EXT@)
  1368. commands use temporary files.
  1369. .
  1370. .
  1371. .TP
  1372. .EnvVar GROFF_TYPESETTER
  1373. Preset the default device.
  1374. .
  1375. If this is not set the
  1376. .B @DEVICE@
  1377. device is used as default.
  1378. .
  1379. This device name is overwritten by the option
  1380. .ShortOpt T .
  1381. .
  1382. .
  1383. .\" --------------------------------------------------------------------
  1384. .SH FILES
  1385. .\" --------------------------------------------------------------------
  1386. .
  1387. There are some directories in which
  1388. .I groff
  1389. installs all of its data files.
  1390. .
  1391. Due to different installation habits on different operating systems,
  1392. their locations are not absolutely fixed, but their function is
  1393. clearly defined and coincides on all systems.
  1394. .
  1395. .
  1396. .\" --------------------------------------------------------------------
  1397. .SS "groff Macro Directory"
  1398. .\" --------------------------------------------------------------------
  1399. .
  1400. This contains all information related to macro packages.
  1401. .
  1402. Note that more than a single directory is searched for those files
  1403. as documented in
  1404. .BR \%groff_tmac (@MAN5EXT@).
  1405. .
  1406. For the groff installation corresponding to this document, it is
  1407. located at
  1408. .IR @MACRODIR@ .
  1409. .
  1410. The following files contained in the
  1411. .I groff macro directory
  1412. have a special meaning:
  1413. .
  1414. .
  1415. .TP
  1416. .B troffrc
  1417. Initialization file for troff.
  1418. .
  1419. This is interpreted by
  1420. .B @g@troff
  1421. before reading the macro sets and any input.
  1422. .
  1423. .
  1424. .TP
  1425. .B troffrc-end
  1426. Final startup file for troff, it is parsed after all macro sets have
  1427. been read.
  1428. .
  1429. .
  1430. .TP
  1431. .IB name .tmac
  1432. .TP+
  1433. .BI tmac. name
  1434. Macro file for macro package
  1435. .IR name .
  1436. .
  1437. .
  1438. .\" --------------------------------------------------------------------
  1439. .SS "groff Font Directory"
  1440. .\" --------------------------------------------------------------------
  1441. .
  1442. This contains all information related to output devices.
  1443. .
  1444. Note that more than a single directory is searched for those files; see
  1445. .BR @g@troff (@MAN1EXT@).
  1446. .
  1447. For the groff installation corresponding to this document, it is
  1448. located at
  1449. .IR @FONTDIR@ .
  1450. .
  1451. The following files contained in the
  1452. .I groff font directory
  1453. have a special meaning:
  1454. .
  1455. .
  1456. .TP
  1457. .BI dev name /DESC
  1458. Device description file for device
  1459. .IR name ,
  1460. see
  1461. .BR \%groff_font (@MAN5EXT@).
  1462. .
  1463. .
  1464. .TP
  1465. .BI dev name / F
  1466. Font file for font
  1467. .I F
  1468. of device
  1469. .IR name .
  1470. .
  1471. .
  1472. .\" --------------------------------------------------------------------
  1473. .SH EXAMPLES
  1474. .\" --------------------------------------------------------------------
  1475. .
  1476. The following example illustrates the power of the
  1477. .B groff
  1478. program as a wrapper around
  1479. .BR @g@troff .
  1480. .
  1481. .P
  1482. To process a roff file using the preprocessors
  1483. .B tbl
  1484. and
  1485. .B pic
  1486. and the
  1487. .B me
  1488. macro set, classical troff had to be called by
  1489. .
  1490. .P
  1491. .ShellCommand pic foo.me | tbl | troff \*[@-]me \*[@-]Tlatin1 | grotty
  1492. .
  1493. .P
  1494. Using
  1495. .BR groff ,
  1496. this pipe can be shortened to the equivalent command
  1497. .P
  1498. .ShellCommand groff \*[@-]p \*[@-]t \*[@-]me \*[@-]T latin1 foo.me
  1499. .
  1500. .P
  1501. An even easier way to call this is to use
  1502. .BR grog (@MAN1EXT@)
  1503. to guess the preprocessor and macro options and execute the generated
  1504. command (by using backquotes to specify shell command substitution)
  1505. .P
  1506. .ShellCommand \`grog \*[@-]Tlatin1 foo.me\`
  1507. .
  1508. .P
  1509. The simplest way is to view the contents in an automated way by
  1510. calling
  1511. .
  1512. .P
  1513. .ShellCommand groffer foo.me
  1514. .
  1515. .
  1516. .\" --------------------------------------------------------------------
  1517. .SH BUGS
  1518. .\" --------------------------------------------------------------------
  1519. .
  1520. .P
  1521. On EBCDIC hosts (e.g. OS/390 Unix), output devices
  1522. .B ascii
  1523. and
  1524. .B latin1
  1525. aren't available.
  1526. .
  1527. Similarly, output for EBCDIC code page
  1528. .B cp1047
  1529. is not available on ASCII based operating systems.
  1530. .
  1531. .P
  1532. Report bugs to bug-groff@gnu.org.
  1533. .
  1534. Include a complete, self-contained example that will allow the bug to
  1535. be reproduced, and say which version of groff you are using.
  1536. .
  1537. .
  1538. .\" --------------------------------------------------------------------
  1539. .SH AVAILABILITY
  1540. .\" --------------------------------------------------------------------
  1541. .
  1542. Information on how to get groff and related information is available
  1543. at the
  1544. .URL http://\:www.gnu.org/\:software/\:groff "GNU website" .
  1545. The most recent released version of groff is available for anonymous
  1546. ftp at the
  1547. .URL ftp://ftp.ffii.org/\:pub/\:groff/\:devel/\:groff-current.tar.gz \
  1548. "groff development site" .
  1549. .
  1550. .P
  1551. Three groff mailing lists are available:
  1552. .TP
  1553. .MTO bug-groff@gnu.org
  1554. for reporting bugs,
  1555. .
  1556. .TP
  1557. .MTO groff@gnu.org
  1558. for general discussion of groff,
  1559. .
  1560. .TP
  1561. .MTO groff-commit@ffii.org
  1562. a read-only list showing logs of commitments to the CVS repository.
  1563. .
  1564. .P
  1565. Details on CVS access and much more can be found in the file
  1566. .B README
  1567. at the top directory of the groff source package.
  1568. .
  1569. .P
  1570. There is a free implementation of the
  1571. .B grap
  1572. preprocessor, written by
  1573. .MTO faber@lunabase.org " Ted Faber" .
  1574. .
  1575. The actual version can be found at the
  1576. .
  1577. .URL http://\:www.lunabase.org/\:~faber/\:Vault/\:software/\:grap/ \
  1578. "grap website" .
  1579. This is the only grap version supported by groff.
  1580. .
  1581. .
  1582. .\" --------------------------------------------------------------------
  1583. .SH AUTHORS
  1584. .\" --------------------------------------------------------------------
  1585. .
  1586. Copyright \(co 1989, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
  1587. .
  1588. .P
  1589. This document is distributed under the terms of the FDL (GNU Free
  1590. Documentation License) version 1.1 or later.
  1591. .
  1592. You should have received a copy of the FDL on your system, it is also
  1593. available on-line at the
  1594. .URL http://\:www.gnu.org/\:copyleft/\:fdl.html "GNU copyleft site" .
  1595. .
  1596. .P
  1597. This document is based on the original groff man page written by
  1598. .MTO jjc@jclark.com "James Clark" .
  1599. .
  1600. It was rewritten, enhanced, and put under the FDL license by
  1601. \m[blue]Bernd Warken\m[].
  1602. .
  1603. It is maintained by
  1604. .MTO wl@gnu.org "Werner Lemberg" .
  1605. .
  1606. .P
  1607. .I groff
  1608. is a GNU free software project.
  1609. .
  1610. All parts of the
  1611. .I groff package
  1612. are protected by GNU copyleft licenses.
  1613. .
  1614. The software files are distributed under the terms of the GNU General
  1615. Public License (GPL), while the documentation files mostly use the GNU
  1616. Free Documentation License (FDL).
  1617. .
  1618. .
  1619. .\" --------------------------------------------------------------------
  1620. .SH "SEE ALSO"
  1621. .\" --------------------------------------------------------------------
  1622. .
  1623. The
  1624. .IR "groff info file"
  1625. contains all information on the groff system within a single document.
  1626. .
  1627. Beneath the detailed documentation of all aspects, it provides
  1628. examples and background information.
  1629. .
  1630. See
  1631. .BR info (1)
  1632. on how to read it.
  1633. .
  1634. .P
  1635. Due to its complex structure, the groff system has many man pages.
  1636. .
  1637. They can be read with
  1638. .BR man (1)
  1639. or
  1640. .BR \%groffer (@MAN1EXT@).
  1641. .
  1642. .TP
  1643. Introduction, history and further readings:
  1644. .BR roff (@MAN7EXT@).
  1645. .
  1646. .TP
  1647. Viewer for groff files:
  1648. .BR \%groffer (@MAN1EXT@),
  1649. .BR \%gxditview (@MAN1EXT@),
  1650. .BR \%xditview (1x).
  1651. .
  1652. .TP
  1653. Wrapper programs for formatters:
  1654. .BR \%groff (@MAN1EXT@),
  1655. .BR \%grog (@MAN1EXT@).
  1656. .
  1657. .TP
  1658. Roff preprocessors:
  1659. .BR \%@g@eqn (@MAN1EXT@),
  1660. .BR \%@g@grn (@MAN1EXT@),
  1661. .BR \%@g@pic (@MAN1EXT@),
  1662. .BR \%@g@refer (@MAN1EXT@),
  1663. .BR \%@g@soelim (@MAN1EXT@),
  1664. .BR \%@g@tbl (@MAN1EXT@),
  1665. .BR grap (1).
  1666. .
  1667. .TP
  1668. Roff language with the groff extensions:
  1669. .BR \%groff (@MAN7EXT@),
  1670. .BR \%groff_char (@MAN7EXT@),
  1671. .BR \%groff_diff (@MAN7EXT@),
  1672. .BR \%groff_font (@MAN5EXT@).
  1673. .
  1674. .TP
  1675. Roff formatter programs:
  1676. .BR \%@g@nroff (@MAN1EXT@),
  1677. .BR \%@g@troff (@MAN1EXT@),
  1678. .BR ditroff (@MAN7EXT@).
  1679. .
  1680. .TP
  1681. The
  1682. .I intermediate output
  1683. language:
  1684. .BR \%groff_out (@MAN7EXT@).
  1685. .
  1686. .TP
  1687. Postprocessors for the output devices:
  1688. .BR \%grodvi (@MAN1EXT@),
  1689. .BR \%grohtml (@MAN1EXT@),
  1690. .BR \%grolbp (@MAN1EXT@),
  1691. .BR \%grolj4 (@MAN1EXT@),
  1692. .BR \%lj4_font (@MAN5EXT@),
  1693. .BR \%grops (@MAN1EXT@),
  1694. .BR \%grotty (@MAN1EXT@).
  1695. .
  1696. .TP
  1697. Groff macro packages and macro-specific utilities:
  1698. .BR \%groff_tmac (@MAN5EXT@),
  1699. .BR \%groff_man (@MAN7EXT@),
  1700. .BR \%groff_mdoc (@MAN7EXT@),
  1701. .BR \%groff_me (@MAN7EXT@),
  1702. .BR \%groff_mm (@MAN7EXT@),
  1703. .BR \%groff_mmse (@MAN7EXT@),
  1704. .BR \%groff_mom (@MAN7EXT@),
  1705. .BR \%groff_ms (@MAN7EXT@),
  1706. .BR \%groff_www (@MAN7EXT@),
  1707. .BR \%groff_trace (@MAN7EXT@),
  1708. .BR \%mmroff (@MAN7EXT@).
  1709. .
  1710. .TP
  1711. The following utilities are available:
  1712. .BR \%addftinfo (@MAN1EXT@),
  1713. .BR \%afmtodit (@MAN1EXT@),
  1714. .BR \%eqn2graph (@MAN1EXT@),
  1715. .BR \%grap2graph (@MAN1EXT@),
  1716. .BR \%groffer (@MAN1EXT@),
  1717. .BR \%gxditview (@MAN1EXT@),
  1718. .BR \%hpftodit (@MAN1EXT@),
  1719. .BR \%@g@indxbib (@MAN1EXT@),
  1720. .BR \%@g@lookbib (@MAN1EXT@),
  1721. .BR \%pfbtops (@MAN1EXT@),
  1722. .BR \%pic2graph (@MAN1EXT@),
  1723. .BR \%tfmtodit (@MAN1EXT@).
  1724. .
  1725. .cp \n[groff_C]
  1726. .
  1727. .\" --------------------------------------------------------------------
  1728. .\" Emacs setup
  1729. .\" --------------------------------------------------------------------
  1730. .
  1731. .\" Local Variables:
  1732. .\" mode: nroff
  1733. .\" End: