nroff.man revision 79550
11590Srgrimes.ig
21590SrgrimesCopyright (C) 1989-2001 Free Software Foundation, Inc.
31590Srgrimes
413840SwoschPermission is granted to make and distribute verbatim copies of
514002Swoschthis manual provided the copyright notice and this permission notice
613684Swoschare preserved on all copies.
71590Srgrimes
81590SrgrimesPermission is granted to copy and distribute modified versions of this
913684Swoschmanual under the conditions for verbatim copying, provided that the
1015008Sjdpentire resulting derived work is distributed under the terms of a
1114147Swoschpermission notice identical to this one.
1214147Swosch
1314147SwoschPermission is granted to copy and distribute translations of this
1415008Sjdpmanual into another language, under the above conditions for modified
1514147Swoschversions, except that this permission notice may be included in
161590Srgrimestranslations approved by the Free Software Foundation instead of in
171590Srgrimesthe original English.
18
19	$FreeBSD: head/contrib/groff/src/roff/nroff/nroff.man 79550 2001-07-10 17:15:31Z ru $
20
21..
22.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 \-h
37.OP \-i
38.OP \-m name
39.OP \-n num
40.OP \-o list
41.OP \-p
42.OP \-r cn
43.OP \-t
44.OP \-S
45.OP \-T name
46.OP \-U
47.OP \-v
48.RI "[\ " file\|.\|.\|. "\ ]"
49.br
50.ad \na
51.SH DESCRIPTION
52The
53.B @g@nroff
54script emulates the
55.B nroff
56command using groff.
57Only 
58.BR ascii ,
59.BR latin1 ,
60.BR koi8-r ,
61.BR utf8 ,
62and
63.B cp1047
64are valid arguments for the
65.B -T
66option.
67If an invalid or no
68.BR \-T
69option is given,
70.B @g@nroff
71checks the current locale to select a default output device.
72It first tries the
73.B locale
74program, then the environment variables
75.BR LC_ALL ,
76.BR LC_CTYPE ,
77and
78.BR LANG ,
79and finally the
80.B LESSCHARSET
81environment variable.
82.PP
83The
84.B \-h
85option
86is equivalent to the
87.BR grotty 's
88.B \-h
89option (i.e., using tabs in the output).
90The
91.BR \-i ,
92.BR \-n ,
93.BR \-m ,
94.B \-o
95and
96.B \-r
97options have the effect described in
98.BR @g@troff (@MAN1EXT@).
99In addition,
100.B @g@nroff
101silently ignores the options
102.BR \-e ,
103.BR \-q ,
104and
105.BR \-s
106(which are not implemented in
107.BR @g@troff ).
108Options 
109.B \-p
110(pic),
111.B \-t
112(tbl),
113.B \-S
114(safer), and
115.B \-U
116(unsafe) are passed to
117.BR groff . 
118.B \-S
119is passed by default.
120.B \-v
121shows the version number.
122.SH ENVIRONMENT
123.TP
124.SM
125.B GROFF_BIN_PATH
126A colon separated list of directories in which to search for the
127.B groff
128executable before searching in PATH.  If unset, `@BINDIR@' is used.
129.SH NOTES
130This shell script is basically intended for use with
131.BR man (1),
132so warnings are suppressed.
133nroff-style character definitions (in the file tty-char.tmac) are also
134loaded to emulate unrepresentable glyphs.
135.SH "SEE ALSO"
136.BR groff (@MAN1EXT@),
137.BR @g@troff (@MAN1EXT@),
138.BR grotty (@MAN1EXT@)
139.
140.\" Local Variables:
141.\" mode: nroff
142.\" End:
143