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

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