src/roff/nroff/nroff.man

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