nroff.man revision 121880
120253Sjoerg.ig
220253SjoergCopyright (C) 1989-2001, 2002 Free Software Foundation, Inc.
320253Sjoerg
420253SjoergPermission is granted to make and distribute verbatim copies of
520253Sjoergthis manual provided the copyright notice and this permission notice
620253Sjoergare preserved on all copies.
720253Sjoerg
820253SjoergPermission is granted to copy and distribute modified versions of this
920253Sjoergmanual under the conditions for verbatim copying, provided that the
1020253Sjoergentire resulting derived work is distributed under the terms of a
1120253Sjoergpermission notice identical to this one.
1220253Sjoerg
1320253SjoergPermission is granted to copy and distribute translations of this
1420253Sjoergmanual into another language, under the above conditions for modified
1520253Sjoergversions, except that this permission notice may be included in
1642074Sjoergtranslations approved by the Free Software Foundation instead of in
1720253Sjoergthe original English.
1820253Sjoerg
1920253Sjoerg	$FreeBSD: head/contrib/groff/src/roff/nroff/nroff.man 121880 2003-11-02 07:27:40Z ru $
2020253Sjoerg
2142074Sjoerg..
2220253Sjoerg.TH @G@NROFF @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
23.SH NAME
24@g@nroff \- emulate nroff command with groff
25.SH SYNOPSIS
26.nr a \n(.j
27.ad l
28.nr i \n(.i
29.in +\w'\fB@g@nroff 'u
30.ti \niu
31.B @g@nroff
32.de OP
33.ie \\n(.$-1 .RI "[\ \fB\\$1\fP" "\\$2" "\ ]"
34.el .RB "[\ " "\\$1" "\ ]"
35..
36.OP \-CchipStUv
37.OP \-d cs
38.OP \-m name
39.OP \-n num
40.OP \-o list
41.OP \-r cn
42.OP \-T name
43.RI "[\ " "file" "\ .\|.\|.\ ]"
44.br
45.ad \na
46.SH DESCRIPTION
47The
48.B @g@nroff
49script emulates the
50.B nroff
51command using groff.
52Only 
53.BR ascii ,
54.BR latin1 ,
55.BR koi8-r ,
56.BR utf8 ,
57and
58.B cp1047
59are valid arguments for the
60.B -T
61option, selecting the output encoding emitted by
62.BR grotty ,
63groff's TTY output device.
64If an invalid or no
65.BR \-T
66option is given,
67.B @g@nroff
68checks the current locale to select a default output device.
69It first tries the
70.B locale
71program, then the environment variables
72.BR LC_ALL ,
73.BR LC_CTYPE ,
74and
75.BR LANG ,
76and finally the
77.B LESSCHARSET
78environment variable.
79.PP
80The
81.B \-h
82and
83.B \-c
84options
85are equivalent to
86.BR grotty 's
87options
88.B \-h
89(using tabs in the output) and
90.B \-c
91(using the old output scheme instead of SGR escape sequences).
92The
93.BR \-d ,
94.BR \-C ,
95.BR \-i ,
96.BR \-m ,
97.BR \-n ,
98.BR \-o ,
99and
100.B \-r
101options have the effect described in
102.BR @g@troff (@MAN1EXT@).
103In addition,
104.B @g@nroff
105silently ignores the options
106.BR \-e ,
107.BR \-q ,
108and
109.BR \-s
110(which are not implemented in
111.BR @g@troff ).
112Options 
113.B \-p
114(pic),
115.B \-t
116(tbl),
117.B \-S
118(safer), and
119.B \-U
120(unsafe) are passed to
121.BR groff . 
122.B \-v
123shows the version number.
124.SH ENVIRONMENT
125.TP
126.SM
127.B GROFF_BIN_PATH
128A colon separated list of directories in which to search for the
129.B groff
130executable before searching in PATH.  If unset, `@BINDIR@' is used.
131.SH NOTES
132This shell script is basically intended for use with
133.BR man (1),
134so warnings are suppressed.
135nroff-style character definitions (in the file tty-char.tmac) are also
136loaded to emulate unrepresentable glyphs.
137.SH "SEE ALSO"
138.BR groff (@MAN1EXT@),
139.BR @g@troff (@MAN1EXT@),
140.BR grotty (@MAN1EXT@)
141.
142.\" Local Variables:
143.\" mode: nroff
144.\" End:
145