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

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