src/roff/nroff/nroff.man

   1 .TH @G@NROFF @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
   2 .SH NAME
   3 @g@nroff \- emulate nroff command with groff
   4 .
   5 .
   6 .\" --------------------------------------------------------------------
   7 .\" Legalese
   8 .\" --------------------------------------------------------------------
   9 .
  10 .de co
  11 Copyright \[co] 1989-2014 Free Software Foundation, Inc.
  12
  13 Permission is granted to make and distribute verbatim copies of
  14 this manual provided the copyright notice and this permission notice
  15 are preserved on all copies.
  16
  17 Permission is granted to copy and distribute modified versions of this
  18 manual under the conditions for verbatim copying, provided that the
  19 entire resulting derived work is distributed under the terms of a
  20 permission notice identical to this one.
  21
  22 Permission is granted to copy and distribute translations of this
  23 manual into another language, under the above conditions for modified
  24 versions, except that this permission notice may be included in
  25 translations approved by the Free Software Foundation instead of in
  26 the original English.
  27 ..
  28 .
  29 .\" --------------------------------------------------------------------
  30 .SH SYNOPSIS
  31 .\" --------------------------------------------------------------------
  32 .
  33 .\" Redefine OP because no spaces are allowed after an option's argument.
  34 .de OP
  35 .  ie \\n(.$-1 \
  36 .    RI "[\fB\\$1\fP" "\\$2" "]"
  37 .  el \
  38 .    RB "[" "\\$1" "]"
  39 ..
  40
  41 .SY @g@nroff
  42 .OP \-CchipStUvwW
  43 .OP \-d cs
  44 .OP \-M dir
  45 .OP \-m name
  46 .OP \-n num
  47 .OP \-o list
  48 .OP \-r cn
  49 .OP \-T name
  50 .RI [ file\~ .\|.\|.]
  51 .
  52 .SY @g@nroff
  53 .B \-\-help
  54 .
  55 .SY @g@nroff
  56 .B \-v
  57 |
  58 .B \-\-version
  59 .YS
  60 .
  61 .\" --------------------------------------------------------------------
  62 .SH DESCRIPTION
  63 .\" --------------------------------------------------------------------
  64 .
  65 The
  66 .B @g@nroff
  67 script emulates the
  68 .B nroff
  69 command using groff.
  70 .
  71 Only
  72 .BR ascii ,
  73 .BR latin1 ,
  74 .BR utf8 ,
  75 and
  76 .B cp1047
  77 are devices accepted by
  78 .BR nroff
  79 to select the output encoding emitted by
  80 .BR grotty ,
  81 groff\[aq]s TTY output device.
  82 .
  83 If neither the
  84 .B GROFF_TYPESETTER
  85 environment variable nor the
  86 .B \-T
  87 command line option (which overrides the environment variable)
  88 specifies a (valid) device,
  89 .B @g@nroff
  90 checks the current locale to select a default output device.
  91 .
  92 It first tries the
  93 .B locale
  94 program, then the environment variables
  95 .BR LC_ALL ,
  96 .BR LC_CTYPE ,
  97 and
  98 .BR LANG ,
  99 and finally the
 100 .B LESSCHARSET
 101 environment variable.
 102 .
 103 .
 104 .PP
 105 The
 106 .B \-h
 107 and
 108 .B \-c
 109 options
 110 are equivalent to
 111 .BR grotty \[aq]s
 112 options
 113 .B \-h
 114 (using tabs in the output) and
 115 .B \-c
 116 (using the old output scheme instead of SGR escape sequences).
 117 .
 118 The
 119 .BR \-d ,
 120 .BR \-C ,
 121 .BR \-i ,
 122 .BR \-M ,
 123 .BR \-m ,
 124 .BR \-n ,
 125 .BR \-o ,
 126 .BR \-r ,
 127 .BR \-w ,
 128 and
 129 .B \-W
 130 options have the effect described in
 131 .BR @g@troff (@MAN1EXT@).
 132 .
 133 In addition,
 134 .B @g@nroff
 135 silently ignores the options
 136 .BR \-e ,
 137 .BR \-q ,
 138 and
 139 .BR \-s
 140 (which are not implemented in
 141 .BR @g@troff ).
 142 .
 143 Options
 144 .B \-p
 145 (pic),
 146 .B \-t
 147 (tbl),
 148 .B \-S
 149 (safer), and
 150 .B \-U
 151 (unsafe) are passed to
 152 .BR groff .
 153 .
 154 .B \-v
 155 and
 156 .B \-\-version
 157 show the version number,
 158 .B \-\-help
 159 prints a help message.
 160 .
 161 .
 162 .\" --------------------------------------------------------------------
 163 .SH ENVIRONMENT
 164 .\" --------------------------------------------------------------------
 165 .
 166 .TP
 167 .SM
 168 .B GROFF_TYPESETTER
 169 The default device for
 170 .BR groff .
 171 If not set (which is the normal case), it defaults to \[oq]ps\[cq].
 172 .
 173 .TP
 174 .SM
 175 .B GROFF_BIN_PATH
 176 A colon separated list of directories in which to search for the
 177 .B groff
 178 executable before searching in PATH.
 179 .
 180 If unset, \[oq]@BINDIR@\[cq] is used.
 181 .
 182 .
 183 .\" --------------------------------------------------------------------
 184 .SH NOTES
 185 .\" --------------------------------------------------------------------
 186 .
 187 This shell script is basically intended for use with
 188 .BR man (1).
 189 nroff-style character definitions (in the file tty-char.tmac) are also
 190 loaded to emulate unrepresentable glyphs.
 191 .
 192 .
 193 .\" --------------------------------------------------------------------
 194 .SH "SEE ALSO"
 195 .\" --------------------------------------------------------------------
 196 .
 197 .BR groff (@MAN1EXT@),
 198 .BR @g@troff (@MAN1EXT@),
 199 .BR grotty (@MAN1EXT@)
 200 .
 201 .
 202 .\" --------------------------------------------------------------------
 203 .SH COPYING
 204 .\" --------------------------------------------------------------------
 205 .co
 206 .
 207 .
 208 .\" Local Variables:
 209 .\" mode: nroff
 210 .\" End: