man/src-nroff.1.in

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