1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
|
Fix manpage bugs
Index: xzip-1.8.2/xzip.1
===================================================================
--- xzip-1.8.2.orig/xzip.1 2014-06-04 01:14:08.144389944 -0500
+++ xzip-1.8.2/xzip.1 2014-06-04 01:14:31.060390476 -0500
@@ -1,8 +1,8 @@
-.TH xzip 1
+.TH xzip 6
.SH Name
xzip \- X Interface to the Z-code Interpreter
.SH Syntax
-.B xzip
+.B xzip
[
.I options ...
]
@@ -16,33 +16,33 @@
.I xzip
is a clean X Windows interface to games written in Infocom's Z-code
game format. It handles Z-code versions 1 through 5, plus the newer
-version 8.
+version 8.
.PP
The interface is heavily (well, completely) based on ATK, an X toolkit
developed at CMU. Really, I would have preferred to actually do this in
-ATK... except that then you'd need ATK to run it, and that's 50
+ATK...\& except that then you'd need ATK to run it, and that's 50
.I megabytes
-of source code. (Honest.) So I just did an imitation.
+of source code. (Honest.) So I just did an imitation.
.SH Mouse Commands
.PP
In the text window:
.PP
-.B Left-click
-to move the dot to the mouse location.
+.B Left-click
+to move the dot to the mouse location.
.br
-.B Click-and-drag
+.B Click-and-drag
to select a large region.
.br
-.B Right-click
+.B Right-click
to extend the selection to the mouse location.
.br
-.B Double-clicking
-selects a word (or extends the selection one word at
+.B Double-clicking
+selects a word (or extends the selection one word at
a time).
.PP
In the scroll bar:
.PP
-.B Left-click on the arrows
+.B Left-click on the arrows
to scroll to the top or bottom.
.br
.B Right-click on the arrows
@@ -57,9 +57,9 @@
.B Right-click in the bar (without dragging)
will scroll up in a similar manner. The top line will scroll down to where you clicked.
.SH Key Commands
-The key commands will be familiar to Emacs users.
-.I meta\-
-combinations can be used either by holding down the
+The key commands will be familiar to Emacs users.
+.I meta-
+combinations can be used either by holding down the
.I meta
key (possibly labelled
.I alt
@@ -70,7 +70,7 @@
The commands listed below are the defaults. They can be customized
with the
.I bindings
-X resource (see below.) \<none> indicates a function which by default
+X resource (see below.) <none> indicates a function which by default
is not bound to any key.
.PP
.B ctrl-f
@@ -151,7 +151,7 @@
.PP
.B meta-0...meta-9
.I (macro)
-Insert a macro string at the dot. By default, all macros are undefined at startup, but you can change this with the
+Insert a macro string at the dot. By default, all macros are undefined at startup, but you can change this with the
.I bindings
option.
.br
@@ -163,11 +163,11 @@
.I (redraw-all-windows)
Redraw text and status windows.
.br
-\<none>
+<none>
.I (redraw-status)
Redraw status window.
.br
-\<none>
+<none>
.I (redraw-screen)
Redraw text window.
.br
@@ -209,17 +209,17 @@
.I (insert-self)
Insert whatever key is bound to this at the dot.
.br
-\<none>
+<none>
.I (no-op)
Do nothing. Bind a key to this to disable it.
.SH Resources and Options
-All the behavior of
+All the behavior of
.I xzip
is controlled by X resources and command-line options. Any particular behavior can be set with either a resource or an option; options override resources.
.PP
Command-line options go on the command line, looking like,
.br
-.I xzip -option value gamefile
+.I xzip \-option value gamefile
.br
Note that even binary options like "justify" must be given a value, "yes" or "no".
.PP
@@ -242,7 +242,7 @@
.IP "\fBbackground: \fIwhite\fR"
The color of the window background.
.IP "\fBgreycolor: \fIgrey60\fR"
-An intermediate color, used for the scroll bar on color displays.
+An intermediate color, used for the scroll bar on color displays.
.IP "\fBjustify: \fIyes\fR"
If "yes", full-justify the text in the text window.
.IP "\fBmarginx: \fI4\fR"
@@ -258,47 +258,47 @@
.IP "\fBhistory: \fI20\fR"
The number of commands to store in the command history.
.IP "\fBbuffer: \fI4000\fR"
-The amount of text (in characters) to keep in the scrollback buffer. If this is made too large, the program can become very slow.
+The amount of text (in characters) to keep in the scrollback buffer. If this is made too large, the program can become very slow.
.IP "\fBstrictz: \fI1\fR"
The level of reporting of various subtle errors in the game file. 0 means that all errors are silently ignored; 1 (the default) means that each error is reported, but only the first time it occurs; 2 means that each error is reported every time it occurs; 3 means that the interpreter will shut down immediately when an error occurs.
.IP "\fBspec: \fIno\fR"
-If "yes", the interpreter will declare itself to be compliant with the Z-machine Specification version 1.0. This is, basically, a lie, since I have not formally reviewed the source for Spec-1.0 compliance. However,
+If "yes", the interpreter will declare itself to be compliant with the Z-machine Specification version 1.0. This is, basically, a lie, since I have not formally reviewed the source for Spec-1.0 compliance. However,
.I xzip
does support every Spec-1.0 feature that I know of, except for the color and Unicode options.
.IP "\fBinputstyle: \fIb\fR"
-The style to display your typed input in. This can be
+The style to display your typed input in. This can be
.I n
for normal text, or
-.I r, b, rb, i,
-.I ri, bi, rbi, f,
-.I rf, bf, rbf, if,
+.I r, b, rb, i,
+.I ri, bi, rbi, f,
+.I rf, bf, rbf, if,
.I rif, bif, rbif
-to specify any combination of Reverse, Bold, Italic, and Fixed. Note that the letters must be in the order shown; you cannot use
+to specify any combination of Reverse, Bold, Italic, and Fixed. Note that the letters must be in the order shown; you cannot use
.I ib
to specify italic and bold.
.IP "\fBX-color: \fI (same as foreground)\fR"
-X may be any of
-.I n, r, b, rb,
-.I i, ri, bi, rbi,
-.I f, rf, bf, rbf,
+X may be any of
+.I n, r, b, rb,
+.I i, ri, bi, rbi,
+.I f, rf, bf, rbf,
.I if, rif, bif, rbif.
This allows you to specify the color of any of the sixteen fonts used by
.I xzip.
-For non-reversed fonts, this is the color of the text; for reversed fonts, it is the color of the field on which the text is displayed. (The text of reversed fonts is always in the background color.)
+For non-reversed fonts, this is the color of the text; for reversed fonts, it is the color of the field on which the text is displayed. (The text of reversed fonts is always in the background color.)
.IP "\fBX-font: \fI\fR"
-X may be any of
-.I n, b, i, bi,
+X may be any of
+.I n, b, i, bi,
.I f, bf, if, bif.
This allows you to specify the sixteen fonts used by
.I xzip.
-(Note that you cannot set the reversed fonts; they always use the same font as their non-reversed counterparts.)
+(Note that you cannot set the reversed fonts; they always use the same font as their non-reversed counterparts.)
.br
The status window always uses the fixed-width fonts; the text window usually (but not always) uses proportional fonts.
.IP "\fBbindings: \fI(see above)\fR"
Key bindings to supplement or override the default bindings. The resource should look like
.br
-.I key=function [, "argument"];
-.I key=function [, "argument"] ...
+.I key=function [, "argument"];
+.I key=function [, "argument"] ...\&
.br
where
.I key
@@ -308,7 +308,7 @@
.I m-
to indicate a meta key.
.I function
-should be one of the function names listed in parentheses in the "Key Bindings" section.
+should be one of the function names listed in parentheses in the "Key Bindings" section.
.I "argument"
(which is optional) should be a quoted string which will be passed to the function. Currently, only the
.I macro
@@ -318,41 +318,41 @@
.br
.I xzip.bindings: c-x=kill-input; m-i=macro,"inventory"; m-d=no-op
.br
-would mean that
-.I ctrl-x
-will delete all input, and
+would mean that
+.I ctrl-x
+will delete all input, and
.I meta-i
will enter the string "inventory", and
-.I meta-d
+.I meta-d
will do nothing. You can have more than one key bound to a function, but you can only have one function bound to a key; later bindings will override earlier ones.
.PP
Ok, I lied; there's one behavior which is set by an environment variable. If you set INFOCOM_PATH to a directory or colon-separated list of directories,
.I xzip
will look there for a story file if it doesn't find it in the current directory.
.SH Quirks
-As always, if you highlight colored text, the result may be surprising. Highlighting "normal" text will be fine, and any other fonts which are the same color, but other colors may highlight in strange ways, and could be hard to read. (This is only a problem for text which is highlighted because it's selected. Text in a reverse font looks correct.)
+As always, if you highlight colored text, the result may be surprising. Highlighting "normal" text will be fine, and any other fonts which are the same color, but other colors may highlight in strange ways, and could be hard to read. (This is only a problem for text which is highlighted because it's selected. Text in a reverse font looks correct.)
.PP
-Certain games (notably
+Certain games (notably
.I Trinity
and
-.I Curses!
-) display pop-up windows, by using the status line in a slightly funky way. They expand the status line, display some text, and then immediately shrink the status line again.
+.IR Curses! )
+display pop-up windows, by using the status line in a slightly funky way. They expand the status line, display some text, and then immediately shrink the status line again.
.br
-I have done my best to support this in
+I have done my best to support this in
.I xzip
\'s two-window system. The pop-up window will be visible from when it is created until the first time you hit
.I Return.
-Then the status window will shrink again. This gives you one "turn" to read the pop-up, which should be sufficient. (In one-window, non-scrolling interpreters, the pop-up appears over your old text, and scrolls away as you continue play.)
+Then the status window will shrink again. This gives you one "turn" to read the pop-up, which should be sufficient. (In one-window, non-scrolling interpreters, the pop-up appears over your old text, and scrolls away as you continue play.)
.br
If you turn off the
.I autoclear
-option, pop-ups will not be erased; use
+option, pop-ups will not be erased; use
.I meta-z
to expand the status window and read them after the window shrinks, and
-.I meta-c
+.I meta-c
to erase them manually. If you do not erase the pop-up, a later pop-up may partially overwrite it, which looks ugly.
.br
-If you turn off the
+If you turn off the
.I autoshrink
option, the status window will not shrink, but the pop-up will still be erased (unless you have turned off
.I autoclear
@@ -361,17 +361,17 @@
The "resizeupward" preference just plain doesn't work. If you use it, the status window will slowly drift downwards as it resizes.
.br
If a timed input (such as
-.I Border
+.I Border
.I Zone
uses) expires while you are editing a line, the dot jumps to the end of the line.
.br
-If a style change occurs in the middle of a word,
+If a style change occurs in the middle of a word,
.I xzip
thinks it's okay to break the word there (when wrapping lines.)
.br
Reverse text has gaps in it in full-justified lines. It also has gaps between lines, in the text window.
.br
-The keybindings are ignored while
+The keybindings are ignored while
.I xzip
is waiting for a single keystroke (as opposed to a line of input.)
.I ctrl-l
@@ -394,8 +394,8 @@
For more information, see the web page:
.I http://www.eblong.com/zarf/xzip.html
.PP
-You are expressly forbidden to use this program on an Infocom game data file
-if, in so doing, you violate the copyright notice supplied with the original
+You are expressly forbidden to use this program on an Infocom game data file
+if, in so doing, you violate the copyright notice supplied with the original
Infocom game.
.br
Parts of this program (the files xinit.c, xio.c, xkey.c, xmess.c, xstat.c, xtext.c) are copyrighted by Andrew Plotkin. These files may be distributed, modified, and used freely, with the exception noted above.
|