Add the DragonFly cvs id and perform general cleanups on cvs/rcs/sccs ids. Most
[dragonfly.git] / contrib / groff / src / roff / nroff / nroff.man
CommitLineData
984263bc
MD
1.ig
2Copyright (C) 1989-2001 Free Software Foundation, Inc.
3
4Permission is granted to make and distribute verbatim copies of
5this manual provided the copyright notice and this permission notice
6are preserved on all copies.
7
8Permission is granted to copy and distribute modified versions of this
9manual under the conditions for verbatim copying, provided that the
10entire resulting derived work is distributed under the terms of a
11permission notice identical to this one.
12
13Permission is granted to copy and distribute translations of this
14manual into another language, under the above conditions for modified
15versions, except that this permission notice may be included in
16translations approved by the Free Software Foundation instead of in
17the original English.
18
19 $FreeBSD: src/contrib/groff/src/roff/nroff/nroff.man,v 1.7.2.3 2003/02/14 15:22:08 ru Exp $
1de703da 20 $DragonFly: src/contrib/groff/src/roff/nroff/Attic/nroff.man,v 1.2 2003/06/17 04:24:02 dillon Exp $
984263bc
MD
21
22..
23.TH @G@NROFF @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
24.SH NAME
25@g@nroff \- emulate nroff command with groff
26.SH SYNOPSIS
27.nr a \n(.j
28.ad l
29.nr i \n(.i
30.in +\w'\fB@g@nroff 'u
31.ti \niu
32.B @g@nroff
33.de OP
34.ie \\n(.$-1 .RI "[\ \fB\\$1\fP" "\\$2" "\ ]"
35.el .RB "[\ " "\\$1" "\ ]"
36..
37.OP \-h
38.OP \-i
39.OP \-m name
40.OP \-n num
41.OP \-o list
42.OP \-p
43.OP \-r cn
44.OP \-S
45.OP \-t
46.OP \-T name
47.OP \-U
48.OP \-v
49.RI "[\ " "file" "\ .\|.\|.\ ]"
50.br
51.ad \na
52.SH DESCRIPTION
53The
54.B @g@nroff
55script emulates the
56.B nroff
57command using groff.
58Only
59.BR ascii ,
60.BR latin1 ,
61.BR koi8-r ,
62.BR utf8 ,
63and
64.B cp1047
65are valid arguments for the
66.B -T
67option.
68If an invalid or no
69.BR \-T
70option is given,
71.B @g@nroff
72checks the current locale to select a default output device.
73It first tries the
74.B locale
75program, then the environment variables
76.BR LC_ALL ,
77.BR LC_CTYPE ,
78and
79.BR LANG ,
80and finally the
81.B LESSCHARSET
82environment variable.
83.PP
84The
85.B \-h
86and
87.B \-c
88options
89are equivalent to
90.BR grotty 's
91options
92.B \-h
93(using tabs in the output) and
94.B \-c
95(using the old output scheme instead of SGR escape sequences).
96The
97.BR \-C ,
98.BR \-i ,
99.BR \-n ,
100.BR \-m ,
101.BR \-o ,
102and
103.B \-r
104options have the effect described in
105.BR @g@troff (@MAN1EXT@).
106In addition,
107.B @g@nroff
108silently ignores the options
109.BR \-e ,
110.BR \-q ,
111and
112.BR \-s
113(which are not implemented in
114.BR @g@troff ).
115Options
116.B \-p
117(pic),
118.B \-t
119(tbl),
120.B \-S
121(safer), and
122.B \-U
123(unsafe) are passed to
124.BR groff .
125.B \-v
126shows the version number.
127.SH ENVIRONMENT
128.TP
129.SM
130.B GROFF_BIN_PATH
131A colon separated list of directories in which to search for the
132.B groff
133executable before searching in PATH. If unset, `@BINDIR@' is used.
134.SH NOTES
135This shell script is basically intended for use with
136.BR man (1),
137so warnings are suppressed.
138nroff-style character definitions (in the file tty-char.tmac) are also
139loaded to emulate unrepresentable glyphs.
140.SH "SEE ALSO"
141.BR groff (@MAN1EXT@),
142.BR @g@troff (@MAN1EXT@),
143.BR grotty (@MAN1EXT@)
144.
145.\" Local Variables:
146.\" mode: nroff
147.\" End: