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