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

  1.ig
  2Copyright (C) 1989-2001, 2002, 2003, 2005 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$
 20
 21..
 22.
 23.TH @G@NROFF @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
 24.
 25.SH NAME
 26@g@nroff \- emulate nroff command with groff
 27.
 28.SH SYNOPSIS
 29.nr a \n(.j
 30.ad l
 31.nr i \n(.i
 32.in +\w'\fB@g@nroff 'u
 33.ti \niu
 34.B @g@nroff
 35.de OP
 36.ie \\n(.$-1 .RI "[\ \fB\\$1\fP" "\\$2" "\ ]"
 37.el .RB "[\ " "\\$1" "\ ]"
 38..
 39.
 40.OP \-CchipStUv
 41.OP \-d cs
 42.OP \-M dir
 43.OP \-m name
 44.OP \-n num
 45.OP \-o list
 46.OP \-r cn
 47.OP \-T name
 48.RI "[\ " "file" "\ .\|.\|.\ ]"
 49.br
 50.ad \na
 51.
 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, selecting the output encoding emitted by
 68.BR grotty ,
 69groff's TTY output device.
 70If an invalid or no
 71.BR \-T
 72option is given,
 73.B @g@nroff
 74checks the current locale to select a default output device.
 75It first tries the
 76.B locale
 77program, then the environment variables
 78.BR LC_ALL ,
 79.BR LC_CTYPE ,
 80and
 81.BR LANG ,
 82and finally the
 83.B LESSCHARSET
 84environment variable.
 85.PP
 86The
 87.B \-h
 88and
 89.B \-c
 90options
 91are equivalent to
 92.BR grotty 's
 93options
 94.B \-h
 95(using tabs in the output) and
 96.B \-c
 97(using the old output scheme instead of SGR escape sequences).
 98The
 99.BR \-d ,
100.BR \-C ,
101.BR \-i ,
102.BR \-M ,
103.BR \-m ,
104.BR \-n ,
105.BR \-o ,
106and
107.B \-r
108options have the effect described in
109.BR @g@troff (@MAN1EXT@).
110In addition,
111.B @g@nroff
112silently ignores the options
113.BR \-e ,
114.BR \-q ,
115and
116.BR \-s
117(which are not implemented in
118.BR @g@troff ).
119Options 
120.B \-p
121(pic),
122.B \-t
123(tbl),
124.B \-S
125(safer), and
126.B \-U
127(unsafe) are passed to
128.BR groff . 
129.B \-v
130shows the version number.
131.
132.SH ENVIRONMENT
133.TP
134.SM
135.B GROFF_BIN_PATH
136A colon separated list of directories in which to search for the
137.B groff
138executable before searching in PATH.  If unset, `@BINDIR@' is used.
139.SH NOTES
140This shell script is basically intended for use with
141.BR man (1),
142so warnings are suppressed.
143nroff-style character definitions (in the file tty-char.tmac) are also
144loaded to emulate unrepresentable glyphs.
145.
146.SH "SEE ALSO"
147.BR groff (@MAN1EXT@),
148.BR @g@troff (@MAN1EXT@),
149.BR grotty (@MAN1EXT@)
150.
151.\" Local Variables:
152.\" mode: nroff
153.\" End: