summaryrefslogtreecommitdiff
path: root/src/roff/nroff/nroff.man
blob: 54c642787578fa62ec7c5fcdd93473220167d5fa (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
.ig
Copyright (C) 1989-2001, 2002, 2003, 2005, 2007, 2009
  Free Software Foundation, Inc.

Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission notice
are preserved on all copies.

Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided that the
entire resulting derived work is distributed under the terms of a
permission notice identical to this one.

Permission is granted to copy and distribute translations of this
manual into another language, under the above conditions for modified
versions, except that this permission notice may be included in
translations approved by the Free Software Foundation instead of in
the original English.
..
.
.TH @G@NROFF @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
.
.SH NAME
@g@nroff \- emulate nroff command with groff
.
.SH SYNOPSIS
.
.\" Redefine OP because no spaces are allowed after an option's argument.
.de OP
.  ie \\n(.$-1 \
.    RI "[\fB\\$1\fP" "\\$2" "]"
.  el \
.    RB "[" "\\$1" "]"
..

.SY @g@nroff
.OP \-CchipStUvwW
.OP \-d cs
.OP \-M dir
.OP \-m name
.OP \-n num
.OP \-o list
.OP \-r cn
.OP \-T name
.RI [ file\~ .\|.\|.]
.
.SY @g@nroff
.B \-\-help
.
.SY @g@nroff
.B \-v
|
.B \-\-version
.YS
.
.SH DESCRIPTION
The
.B @g@nroff
script emulates the
.B nroff
command using groff.
Only
.BR ascii ,
.BR latin1 ,
.BR utf8 ,
and
.B cp1047
are devices accepted by
.BR nroff
to select the output encoding emitted by
.BR grotty ,
groff's TTY output device.
If neither the
.B GROFF_TYPESETTER
environment variable nor the
.B \-T
command line option (which overrides the environment variable)
specifies a (valid) device,
.B @g@nroff
checks the current locale to select a default output device.
It first tries the
.B locale
program, then the environment variables
.BR LC_ALL ,
.BR LC_CTYPE ,
and
.BR LANG ,
and finally the
.B LESSCHARSET
environment variable.
.PP
The
.B \-h
and
.B \-c
options
are equivalent to
.BR grotty 's
options
.B \-h
(using tabs in the output) and
.B \-c
(using the old output scheme instead of SGR escape sequences).
The
.BR \-d ,
.BR \-C ,
.BR \-i ,
.BR \-M ,
.BR \-m ,
.BR \-n ,
.BR \-o ,
.BR \-r ,
.BR \-w ,
and
.B \-W
options have the effect described in
.BR @g@troff (@MAN1EXT@).
In addition,
.B @g@nroff
silently ignores the options
.BR \-e ,
.BR \-q ,
and
.BR \-s
(which are not implemented in
.BR @g@troff ).
Options
.B \-p
(pic),
.B \-t
(tbl),
.B \-S
(safer), and
.B \-U
(unsafe) are passed to
.BR groff .
.B \-v
and
.B \-\-version
show the version number,
.B \-\-help
prints a help message.
.
.SH ENVIRONMENT
.TP
.SM
.B GROFF_TYPESETTER
The default device for
.BR groff .
If not set (which is the normal case), it defaults to `ps'.
.
.TP
.SM
.B GROFF_BIN_PATH
A colon separated list of directories in which to search for the
.B groff
executable before searching in PATH.  If unset, `@BINDIR@' is used.
.
.SH NOTES
This shell script is basically intended for use with
.BR man (1).
nroff-style character definitions (in the file tty-char.tmac) are also
loaded to emulate unrepresentable glyphs.
.
.SH "SEE ALSO"
.BR groff (@MAN1EXT@),
.BR @g@troff (@MAN1EXT@),
.BR grotty (@MAN1EXT@)
.
.\" Local Variables:
.\" mode: nroff
.\" End: