nroff.man revision 114410
1.ig
2Copyright (C) 1989-2001, 2002 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: head/contrib/groff/src/roff/nroff/nroff.man 114410 2003-05-01 13:18:29Z 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 \-CchipStUv
37.OP \-m name
38.OP \-n num
39.OP \-o list
40.OP \-r cn
41.OP \-T name
42.RI "[\ " "file" "\ .\|.\|.\ ]"
43.br
44.ad \na
45.SH DESCRIPTION
46The
47.B @g@nroff
48script emulates the
49.B nroff
50command using groff.
51Only 
52.BR ascii ,
53.BR latin1 ,
54.BR koi8-r ,
55.BR utf8 ,
56and
57.B cp1047
58are valid arguments for the
59.B -T
60option, selecting the output encoding emitted by
61.BR grotty ,
62groff's TTY output device.
63If an invalid or no
64.BR \-T
65option is given,
66.B @g@nroff
67checks the current locale to select a default output device.
68It first tries the
69.B locale
70program, then the environment variables
71.BR LC_ALL ,
72.BR LC_CTYPE ,
73and
74.BR LANG ,
75and finally the
76.B LESSCHARSET
77environment variable.
78.PP
79The
80.B \-h
81and
82.B \-c
83options
84are equivalent to
85.BR grotty 's
86options
87.B \-h
88(using tabs in the output) and
89.B \-c
90(using the old output scheme instead of SGR escape sequences).
91The
92.BR \-C ,
93.BR \-i ,
94.BR \-m ,
95.BR \-n ,
96.BR \-o ,
97and
98.B \-r
99options have the effect described in
100.BR @g@troff (@MAN1EXT@).
101In addition,
102.B @g@nroff
103silently ignores the options
104.BR \-e ,
105.BR \-q ,
106and
107.BR \-s
108(which are not implemented in
109.BR @g@troff ).
110Options 
111.B \-p
112(pic),
113.B \-t
114(tbl),
115.B \-S
116(safer), and
117.B \-U
118(unsafe) are passed to
119.BR groff . 
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