src/devices/grotty/grotty.man

   1 .ig \"-*- nroff -*-
   2 Copyright (C) 1989-2000 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 GROTTY @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
  20 .SH NAME
  21 grotty \- groff driver for typewriter-like devices
  22 .SH SYNOPSIS
  23 .B grotty
  24 [
  25 .B \-hfbuodBUv
  26 ] [
  27 .BI \-F dir
  28 ] [
  29 .IR files \|.\|.\|.
  30 ]
  31 .PP
  32 It is possible to have whitespace between the
  33 .B \-F
  34 option and its parameter.
  35 .SH DESCRIPTION
  36 .B grotty
  37 translates the output of GNU
  38 .B troff
  39 into a form suitable for typewriter-like devices.
  40 Normally
  41 .B grotty
  42 should invoked by using the
  43 .B groff
  44 command
  45 with a
  46 .BR \-Tascii ,
  47 .B \-Tlatin1
  48 or
  49 .B \-Tutf8
  50 option on ASCII based systems, and with
  51 .B \-Tcp1047
  52 on EBCDIC based hosts.
  53 If no files are given,
  54 .B grotty
  55 will read the standard input.
  56 A filename of
  57 .B \-
  58 will also cause
  59 .B grotty
  60 to read the standard input.
  61 Output is written to the standard output.
  62 .LP
  63 Normally
  64 .B grotty
  65 prints a bold character
  66 .I c
  67 using the sequence
  68 .RI ` c
  69 .SM BACKSPACE
  70 .IR c '
  71 and a italic character
  72 .I c
  73 by the sequence
  74 .RB ` _
  75 .SM BACKSPACE
  76 .IR c '.
  77 These sequences can be displayed on a terminal
  78 by piping through
  79 .BR ul (1).
  80 Pagers such as
  81 .BR more (1)
  82 or
  83 .BR less (1)
  84 are also able to display these sequences.
  85 Use either
  86 .B \-B
  87 or
  88 .B \-U
  89 when piping into
  90 .BR less (1);
  91 use
  92 .B \-b
  93 when piping into
  94 .BR more (1).
  95 There is no need to filter the output through
  96 .BR col (1)
  97 since
  98 .B grotty
  99 never outputs reverse line feeds.
 100 .LP
 101 The font description file may contain a command
 102 .IP
 103 .BI internalname\  n
 104 .LP
 105 where
 106 .I n
 107 is a decimal integer.
 108 If the 01 bit in
 109 .I n
 110 is set,
 111 then the font will be treated as an italic font;
 112 if the 02 bit is set,
 113 then it will be treated as a bold font.
 114 The code field in the font description field gives the
 115 code which will be used to output the character.
 116 This code can also be used in the
 117 .B \eN
 118 escape sequence in
 119 .BR troff .
 120 .SH OPTIONS
 121 .TP
 122 .BI \-F dir
 123 Search the directory
 124 .IB dir /dev name
 125 for font and device description files;
 126 .I name
 127 is the name of the device, usually
 128 .BR ascii ,
 129 .BR latin1 ,
 130 .BR utf8 ,
 131 or
 132 .BR cp1047 .
 133 .TP
 134 .B \-h
 135 Use horizontal tabs in the output.
 136 Tabs are assumed to be set every 8 columns.
 137 .TP
 138 .B \-f
 139 Use form feeds in the output.
 140 A form feed will be output at the end of each page that has no output
 141 on its last line.
 142 .TP
 143 .B \-b
 144 Suppress the use of overstriking for bold characters.
 145 .TP
 146 .B \-u
 147 Suppress the use of underlining for italic characters.
 148 .TP
 149 .B \-B
 150 Use only overstriking for bold-italic characters.
 151 .TP
 152 .B \-U
 153 Use only underlining for bold-italic characters.
 154 .TP
 155 .B \-o
 156 Suppress overstriking (other than for bold or underlined characters).
 157 .TP
 158 .B \-d
 159 Ignore all
 160 .B \eD
 161 commands.
 162 Without this
 163 .B grotty
 164 will render
 165 .B \eD'l\|.\|.\|.'
 166 commands that have at least at least one zero argument
 167 (and so are either horizontal or vertical)
 168 using
 169 .BR \- ,
 170 .B |
 171 and
 172 .B +
 173 characters.
 174 .TP
 175 .B \-v
 176 Print the version number.
 177 .SH FILES
 178 .TP
 179 .B @FONTDIR@/devascii/DESC
 180 Device description file for
 181 .B ascii
 182 device.
 183 .TP
 184 .BI @FONTDIR@/devascii/ F
 185 Font description file for font
 186 .I F
 187 of
 188 .B ascii
 189 device.
 190 .TP
 191 .B @FONTDIR@/devlatin1/DESC
 192 Device description file for
 193 .B latin1
 194 device.
 195 .TP
 196 .BI @FONTDIR@/devlatin1/ F
 197 Font description file for font
 198 .I F
 199 of
 200 .B latin1
 201 device.
 202 .TP
 203 .B @FONTDIR@/devutf8/DESC
 204 Device description file for
 205 .B utf8
 206 device.
 207 .TP
 208 .BI @FONTDIR@/devutf8/ F
 209 Font description file for font
 210 .I F
 211 of
 212 .B utf8
 213 device.
 214 .TP
 215 .B @FONTDIR@/devcp1047/DESC
 216 Device description file for
 217 .B cp1047
 218 device.
 219 .TP
 220 .BI @FONTDIR@/devcp1047/ F
 221 Font description file for font
 222 .I F
 223 of
 224 .B cp1047
 225 device.
 226 .TP
 227 .B @MACRODIR@/tmac.tty
 228 Macros for use with
 229 .BR grotty .
 230 .TP
 231 .B @MACRODIR@/tmac.tty-char
 232 Additional klugey character definitions for use with
 233 .BR grotty .
 234 .LP
 235 Note that on EBCDIC hosts, only files for the
 236 .B cp1047
 237 device will be installed.
 238 .SH BUGS
 239 .LP
 240 .B grotty
 241 is intended only for simple documents.
 242 .LP
 243 There is no support for fractional horizontal or vertical motions.
 244 .LP
 245 There is no support for
 246 .B \eD
 247 commands
 248 other than horizontal and vertical lines.
 249 .LP
 250 Characters above the first line (ie with a vertical position of 0)
 251 cannot be printed.
 252 .SH "SEE ALSO"
 253 .BR groff (@MAN1EXT@),
 254 .BR @g@troff (@MAN1EXT@),
 255 .BR groff_out (@MAN5EXT@),
 256 .BR groff_font (@MAN5EXT@),
 257 .BR groff_char (@MAN7EXT@),
 258 .BR ul (1),
 259 .BR more (1),
 260 .BR less (1)