1.1 --- a/doc/bookloupe.txt Fri Jan 27 10:30:16 2012 +0000
1.2 +++ b/doc/bookloupe.txt Sat Jul 20 11:07:02 2013 +0100
1.3 @@ -1,30 +1,26 @@
1.4
1.5
1.6 - Gutcheck documentation
1.7 + Bookloupe documentation
1.8
1.9
1.10 -gutcheck: lists possible common formatting errors in a Project
1.11 -Gutenberg candidate file. It is a command line program and can be used
1.12 -under Win32 or Unix (gutcheck.c should compile anywhere; if it doesn't,
1.13 -tell me). For Windows-only people, there is an appendix at the end
1.14 -with brief instructions for running it.
1.15 +bookloupe: lists possible common formatting errors in a Project
1.16 +Gutenberg candidate file. Bookloupe is based on gutcheck, written
1.17 +by Jim Tinsley. It is a command line program and can be used under
1.18 +Microsoft Windows, Mac or Unix. For Windows-only people, there is
1.19 +an appendix at the end with brief instructions for running it.
1.20
1.21 +Current version: 1.90, a beta version leading up to version 2.0
1.22
1.23 -Current version: 0.99. Users of 0.98 see end of file for changes.
1.24 +This software is Copyright Jim Tinsley 2000-2005 and
1.25 +J. Ali Harlow 2012 onwards.
1.26
1.27 -You should also have received the licence file COPYING, a README file,
1.28 -gutcheck.c, the source code, and gutcheck.exe, a DOS executable, with
1.29 -this file.
1.30 -
1.31 -This software is Copyright Jim Tinsley 2000-2005.
1.32 -
1.33 -Gutcheck comes wih ABSOLUTELY NO WARRANTY. For details, read the file COPYING.
1.34 +Bookloupe comes wih ABSOLUTELY NO WARRANTY. For details, read the file COPYING.
1.35 This is Free Software; you may redistribute it under certain conditions (GPL).
1.36
1.37 -See http://gutcheck.sourceforge.net for the latest version.
1.38 +See http://www.juiblex.co.uk/pgdp/bookloupe/ for the latest version.
1.39
1.40
1.41 -Usage is: gutcheck [-setopxlywm] filename
1.42 +Usage is: bookloupe [-setopxlywm] filename
1.43 where:
1.44 -s checks Single quotes
1.45 -e switches off Echoing of lines
1.46 @@ -40,36 +36,43 @@
1.47 -u warns about words in a user-defined typo file gutcheck.typ
1.48 -d ignores some DP-specific markup
1.49
1.50 -Running gutcheck without any parameters will display a brief help message.
1.51 +Running bookloupe without any parameters will display a brief help message.
1.52
1.53 Sample usage:
1.54
1.55 - gutcheck warpeace.txt
1.56 + bookloupe warpeace.txt
1.57
1.58
1.59 More detail:
1.60
1.61 + Character encoding
1.62 +
1.63 + Bookloupe will handle e-texts encoded in UTF-8 (preferred),
1.64 + ISO-8859-1 (also known as Latin-1), or WINDOWS-1252 (also known,
1.65 + incorrectly, as ansi). The output will be in the same encoding
1.66 + as the input e-text.
1.67 +
1.68 Echoing lines (-e to switch off)
1.69
1.70 - You may find it convenient, when reviewing Gutcheck's
1.71 - suggestions, to see the line that Gutcheck is questioning.
1.72 + You may find it convenient, when reviewing Bookloupe's
1.73 + suggestions, to see the line that Bookloupe is questioning.
1.74 That way, you can often see at a glance whether it is
1.75 a real error that needs to be fixed, or a false positive
1.76 - that should be in the text, but Gutcheck's limited
1.77 + that should be in the text, but Bookloupe's limited
1.78 programming doesn't understand.
1.79
1.80 - By default, gutcheck echoes these lines, but if you don't
1.81 + By default, bookloupe echoes these lines, but if you don't
1.82 want to see the lines referred to, -e will switch it OFF.
1.83
1.84
1.85 Quotes (-s and -p switches)
1.86
1.87 - Gutcheck always looks for unbalanced doublequotes in a
1.88 + Bookloupe always looks for unbalanced doublequotes in a
1.89 paragraph. It is a common convention for writers not to
1.90 close quotes in a paragraph if the next paragraph opens
1.91 with quotes and is a continuation by the same speaker.
1.92
1.93 - Gutcheck therefore does not normally report unclosed quotes
1.94 + Bookloupe therefore does not normally report unclosed quotes
1.95 if the next paragraph begins with a quote. If you need
1.96 to see all unclosed quotes, even where the next paragraph
1.97 begins with a quote, you should use the -p switch.
1.98 @@ -84,7 +87,7 @@
1.99 for contractions rather than quotes, but it isn't easy
1.100 to get a program to recognize that.
1.101
1.102 - Since Gutcheck makes too many mistakes when trying to match
1.103 + Since bookloupe makes too many mistakes when trying to match
1.104 singlequotes, it doesn't look for unbalanced singlequotes
1.105 unless you specify the -s switch.
1.106
1.107 @@ -102,7 +105,7 @@
1.108
1.109 Typos (-t switch)
1.110
1.111 - It's not Gutcheck's job to be a spelling checker, but it
1.112 + It's not bookoupe's job to be a spelling checker, but it
1.113 does check for a list of common typos and OCR errors if you
1.114 use the -t switch. (The -x switch also turns typo checking on.)
1.115
1.116 @@ -113,7 +116,7 @@
1.117 playing the odds - a few false positives for many errors found.
1.118 Similarly with "ii", which is a very common OCR error.
1.119
1.120 - Gutcheck suppresses multiple reporting of the first 40 "typos"
1.121 + Bookloupe suppresses multiple reporting of the first 40 "typos"
1.122 found. This is to remove the annoyance of seeing something like
1.123 "FN" (footnote) or "LK" (initials) flagged as a typo 147 times
1.124 in a text.
1.125 @@ -127,11 +130,11 @@
1.126 and Mac have different conventions, but the final text should
1.127 always use a CR/LF pair as its line terminator.
1.128
1.129 - By default, Gutcheck verifies that every line does have
1.130 + By default, bookloupe verifies that every line does have
1.131 the correct terminator, but if you're on a work-in-progress
1.132 in Linux, you might want to convert the line-ends as a final
1.133 step, and not want to see thousands of errors every time you
1.134 - run Gutcheck before that final step, so you can turn off
1.135 + run bookloupe before that final step, so you can turn off
1.136 this checking with the -l switch.
1.137
1.138
1.139 @@ -143,101 +146,103 @@
1.140
1.141 Overview mode (-o switch)
1.142
1.143 - This mode just gives a count of queries found
1.144 - instead of a detailed list.
1.145 + This mode just gives a count of queries found
1.146 + instead of a detailed list.
1.147
1.148
1.149 Header quote (-h switch)
1.150
1.151 - If you use the -h switch, gutcheck will also display
1.152 - the Title, Author, Release and Edition fields from the
1.153 - PG header. This is useful mostly for the automated
1.154 - checks we do on recently-posted texts.
1.155 + If you use the -h switch, bookloupe will also display
1.156 + the Title, Author, Release and Edition fields from the
1.157 + PG header. This is useful mostly for the automated
1.158 + checks we do on recently-posted texts.
1.159
1.160
1.161 Errors to stdout (-y switch)
1.162
1.163 - If you're just running gutcheck normally, you can ignore
1.164 - this. It's only there for programs that provide a front
1.165 - end to gutcheck. It makes error messages appear within
1.166 - the output of gutcheck so that the front end knows whether
1.167 - gutcheck ran OK.
1.168 + If you're just running bookloupe normally, you can ignore
1.169 + this. It's only there for programs that provide a front
1.170 + end to bookloupe. It makes error messages appear within
1.171 + the output of bookloupe so that the front end knows whether
1.172 + bookloupe ran OK.
1.173
1.174
1.175 Verbose reporting (-v switch)
1.176
1.177 - Normally, if gutcheck sees lots of long lines, short lines,
1.178 - spaced dashes, non-ASCII characters or dot-commas ".," it
1.179 - assumes these are features of the text, counts and summarizes
1.180 - them at the top of its report, but does not list them
1.181 - individually. If the -v switch is on, gutcheck will list them all.
1.182 + Normally, if bookloupe sees lots of long lines, short lines,
1.183 + spaced dashes, non-ASCII characters or dot-commas ".," it
1.184 + assumes these are features of the text, counts and summarizes
1.185 + them at the top of its report, but does not list them
1.186 + individually. If the -v switch is on, bookloupe will list them all.
1.187
1.188
1.189 Markup interpretation (-m switch)
1.190
1.191 - Normally, gutcheck flags anything it suspects of being HTML
1.192 - markup as a possible error. When you use the -m switch,
1.193 - however, it matches anything that looks like markup against
1.194 - a short list of common HTML tags and entities. If the markup
1.195 - is in that list, it either ignores the markup, in the case
1.196 - of a tag, or "interprets" the markup as its nearest ASCII
1.197 - equivalent, in the case of an entity. So, for example, using
1.198 - this switch, gutcheck will "see"
1.199 + Normally, bookloupe flags anything it suspects of being HTML
1.200 + markup as a possible error. When you use the -m switch,
1.201 + however, it matches anything that looks like markup against
1.202 + a short list of common HTML tags and entities. If the markup
1.203 + is in that list, it either ignores the markup, in the case
1.204 + of a tag, or "interprets" the markup as its nearest ASCII
1.205 + equivalent, in the case of an entity. So, for example, using
1.206 + this switch, bookloupe will "see"
1.207
1.208 - “He went <i>thataway!</i>”
1.209 + “He went <i>thataway!</i>”
1.210
1.211 - as
1.212 + as
1.213
1.214 - "He went thataway!"
1.215 + "He went thataway!"
1.216
1.217 - and report accordingly.
1.218 + and report accordingly.
1.219
1.220 - This switch does not, not, NOT check the validity of HTML;
1.221 - it exists so that you can run gutcheck on most HTML texts
1.222 - for PG, and get sane results. It does not support all tags.
1.223 - It does not support all entities. When it sees a tag or entity
1.224 - it does not recognize, it will query it as HTML just as if
1.225 - you hadn't specified the -m switch.
1.226 + This switch does not, not, NOT check the validity of HTML;
1.227 + it exists so that you can run bookloupe on most HTML texts
1.228 + for PG, and get sane results. It does not support all tags.
1.229 + It does not support all entities. When it sees a tag or entity
1.230 + it does not recognize, it will query it as HTML just as if
1.231 + you hadn't specified the -m switch.
1.232
1.233 - Gutcheck 0.99 will automatically switch on markup interpretation
1.234 - if it sees a lot of tags that appear to be markup, so mostly, you
1.235 - won't have to specify this.
1.236 + Bookloupe will automatically switch on markup interpretation
1.237 + if it sees a lot of tags that appear to be markup, so mostly, you
1.238 + won't have to specify this.
1.239
1.240 User-defined typos (-u switch)
1.241
1.242 - If you have a file named gutcheck.typ either in your current
1.243 - working directory or in the directory from which you explicitly
1.244 - invoked gutcheck, but not necessarily on your path, and if you
1.245 - specify the -u switch, gutcheck will query any word specified
1.246 - in that file. The file is simple: one word, in lower case, per
1.247 - line. 999 lines are allowed for. Be careful not to put multiple
1.248 - words onto a line, or leave any rubbish other than the word on
1.249 - the line. You should have received a sample file gutcheck.typ
1.250 - with this package.
1.251 + If you have a file named bookloupe.typ or gutcheck.typ either
1.252 + in your current working directory or in the directory from
1.253 + which you explicitly invoked bookoupe, but not necessarily on
1.254 + your path, and if you specify the -u switch, bookloupe will
1.255 + query any word specified in that file. The file is simple: one
1.256 + word, in lower case, per line. Be careful not to put multiple
1.257 + words onto a line, or leave any rubbish other than the word on
1.258 + the line. You should have received a sample file bookloupe.typ
1.259 + with this package. The file may be encoded in UTF-8 (preferred),
1.260 + ISO-8859-1 (also known as Latin-1), or WINDOWS-1252 (also known,
1.261 + incorrectly, as ansi).
1.262
1.263 Ignore DP markup (-d switch)
1.264
1.265 - Distributed Proofreaders (http://www.pgdp.net) is currently
1.266 - (2005) the main source of PG texts, and proofers there use
1.267 - special conventions. This switch understands those conventions,
1.268 - so that people can use gutcheck on files in process that still
1.269 - haven't had the special conventions removed yet. The special
1.270 - conventions supported in 0.99 are page-separators and
1.271 - "<sc>", "</sc>", "/*", "*/", "/#", "#/", "/$", "$/".
1.272 + Distributed Proofreaders (http://www.pgdp.net) has for some
1.273 + time been the main source of PG texts, and proofers there use
1.274 + special conventions. This switch understands those conventions,
1.275 + so that people can use bookloupe on files in process that still
1.276 + haven't had the special conventions removed yet. The special
1.277 + conventions supported are page-separators and
1.278 + "<sc>", "</sc>", "/*", "*/", "/#", "#/", "/$", "$/".
1.279
1.280
1.281 -You will probably only run gutcheck on a text once or maybe twice,
1.282 +You will probably only run bookloupe on a text once or maybe twice,
1.283 just prior to uploading; it usually finds a few formatting problems;
1.284 it also usually finds queries that aren't problems at all - it often
1.285 questions Tables of Contents for having short lines, for example.
1.286 -These are called "false positives", and need a human to decide on
1.287 +These are called "false positives," and need a human to decide on
1.288 them.
1.289
1.290 The text should be standard prose, and already close to PG normal
1.291 format (plain text, about 70 characters per line with blank lines
1.292 between paragraphs).
1.293
1.294 -Gutcheck merely draws your attention to things that might be errors.
1.295 +Bookloupe merely draws your attention to things that might be errors.
1.296 It is NOT a substitute for human judgement. Formatting choices like
1.297 short lines may be for a reason that this program can't understand.
1.298
1.299 @@ -246,8 +251,8 @@
1.300 them. Of these, spellchecking (with _very_ careful human judgement) is
1.301 the most important and most useful.
1.302
1.303 -Gutcheck does perform some basic typo-checking if you ask it to,
1.304 -but its focus is on formatting errors specific to PG texts -
1.305 +Bookloupe does perform some basic typo-checking if you ask it to,
1.306 +but its focus is on formatting errors specific to PG texts—
1.307 mismatched quotes, non-ASCII characters, bad spacing, bad line
1.308 length, HTML tags perhaps left from a conversion, unbalanced
1.309 brackets.
1.310 @@ -258,7 +263,7 @@
1.311
1.312
1.313
1.314 - How do _I_ use it?
1.315 + How does Jim Tinsley use gutcheck?
1.316
1.317 Practically everyone I give gutcheck to asks me how _I_ use it.
1.318 Well, when I get a text for posting, say filename.txt, I run
1.319 @@ -291,33 +296,23 @@
1.320
1.321
1.322
1.323 - Future development of gutcheck
1.324 + Future development of bookloupe
1.325
1.326 -Gutcheck has gone about as far as it can, given its current
1.327 -structure. In order to add better singlequotes checking,
1.328 -sentence checking, better he/be checking and other good stuff
1.329 -that I'd like to see, I'll have to rewrite it from a different
1.330 -angle - looking at the syntax instead of the lines. And I'll
1.331 -probably get around to that sooner or later.
1.332 +Bookloupe version 2.0 is intended to add UTF-8 support to
1.333 +gutcheck. All the functionality should already be implemented
1.334 +in the beta versions leading up to version 2.0, although
1.335 +some bugs may well remain.
1.336
1.337 -Meantime, I'm just trying to get this version stabilized, so
1.338 -please report any bugs you find. When it is stable, I'll run
1.339 -up a Windows port for those timid souls who can't look a
1.340 -command line in the eye. :-)
1.341 +Future versions will add support for UTF-8 characters that
1.342 +are not in ISO-8859-1 (eg., curled quotation marks);
1.343 +characters that do not have a composed form (version 2
1.344 +treats these as taking 2 or more columns); zero width and
1.345 +wide characters (version 2 treats these as taking 1 column).
1.346
1.347 -And I've started work on gutspell, a companion to gutcheck
1.348 -which will concentrate on spelling problems. PG spelling
1.349 -problems are unusual, since the range of texts we cover is
1.350 -so wide, and I'll be taking a somewhat unorthodox approach
1.351 -to writing this spelling-checker _specifically_ for texts
1.352 -containing a lot of dialect and uncommon words that have
1.353 -probably already been spell-checked against a standard
1.354 -modern dictionary.
1.355
1.356
1.357
1.358 -
1.359 -Explanations of common gutcheck messages:
1.360 +Explanations of common bookloupe messages:
1.361
1.362 --> 74 lines in this file have white space at end
1.363
1.364 @@ -330,7 +325,7 @@
1.365 --> 84 lines in this file are long. Not reporting long lines.
1.366 --> 8 lines in this file are VERY long!
1.367
1.368 - If there are a lot of long or short lines, Gutcheck won't list
1.369 + If there are a lot of long or short lines, bookloupe won't list
1.370 them individually. The short lines version of this message
1.371 is commonly seen when gutchecking poetry and some plays, where
1.372 the normal line length is shorter than the standard for prose.
1.373 @@ -345,7 +340,7 @@
1.374 The PG standard for an emdash--like these--is two minus signs
1.375 with no spaces before or after them. However, some older texts
1.376 used spaced dashes - like these -- and if there are very many
1.377 - such spaced dashes in the file, gutcheck just draws your
1.378 + such spaced dashes in the file, bookoupe just draws your
1.379 attention to it and doesn't list them individually.
1.380
1.381
1.382 @@ -357,12 +352,11 @@
1.383 represented according to several different non-ASCII encoding
1.384 schemes, using values over 127. If you have a plain English text
1.385 with a few accented characters in words like cafe or tete-a-tete,
1.386 - you should replace the accented characters with their unaccented
1.387 + you might replace the accented characters with their unaccented
1.388 versions. The English pound sign is another commonly-seen
1.389 non-ASCII character. If you have enough non-ASCII characters in
1.390 - your text that you feel removing them would degrade your text
1.391 - unacceptably, you should probably consider doing an 8-bit text
1.392 - as well as a plain-ASCII version.
1.393 + your text that you feel removing them would degrade your text,
1.394 + you should probably consider doing a UTF-8 text.
1.395
1.396
1.397
1.398 @@ -391,7 +385,7 @@
1.399
1.400 The tilde character (~) might be legitimately used, but it's the
1.401 character commonly used by OCR software to indicate a place where
1.402 - it couldn't make out the letter, so gutcheck flags it.
1.403 + it couldn't make out the letter, so bookloupe flags it.
1.404
1.405
1.406
1.407 @@ -407,7 +401,7 @@
1.408
1.409 PG texts should have lines shorter than 76. There may be occasions
1.410 where you decide that you really have to go out to 79 characters,
1.411 - but the sample above says that line 1451 is 129 characters long -
1.412 + but the sample above says that line 1451 is 129 characters long—
1.413 probably two lines run together.
1.414
1.415
1.416 @@ -416,12 +410,12 @@
1.417
1.418 PG texts should have lines longer than 54 characters. However,
1.419 there are special cases like poetry and tables of contents where
1.420 - the lines _should_ be shorter. So treat Gutcheck warnings about
1.421 + the lines _should_ be shorter. So treat bookloupe warnings about
1.422 short lines carefully. Sometimes it's a genuine formatting
1.423 problem; sometimes the line really needs to be short.
1.424
1.425 - Hint: gutcheck will not flag lines as short if they are indented
1.426 - - if they start with a space. I like to start inserted stanzas
1.427 + Hint: bookloupe will not flag lines as short if they are indented
1.428 + —if they start with a space. I like to start inserted stanzas
1.429 and other such items indented with a couple of spaces so that
1.430 they stand out from the main text anyway.
1.431
1.432 @@ -437,7 +431,7 @@
1.433 Line 1850 - Spaced em-dash?
1.434
1.435 The PG standard for an em-dash--like these--is two minus signs
1.436 - with no spaces before or after them. Gutcheck flags non-PG
1.437 + with no spaces before or after them. Bookloupe flags non-PG
1.438 em-dashes - like this one. Normally, you will replace it with a
1.439 PG-standard em-dash.
1.440
1.441 @@ -445,7 +439,7 @@
1.442
1.443 Line 1904 - Query he/be error?
1.444
1.445 - Gutcheck makes a very minor effort to look for that scourge of all
1.446 + Bookloupe makes a very minor effort to look for that scourge of all
1.447 proofreaders, "be" replacing "he" or vice-versa, and draws your
1.448 attention to it when it thinks it has found one.
1.449
1.450 @@ -454,7 +448,7 @@
1.451 Line 2017 - Query digit in a1most
1.452
1.453 The digit 1 is commonly OCRed for the letter l, the digit 0 for
1.454 - the letter O, and so on. When gutcheck sees a mix of digits and
1.455 + the letter O, and so on. When bookloupe sees a mix of digits and
1.456 letters, it warns you. It may generate a false positive for
1.457 something like 7am.
1.458
1.459 @@ -462,7 +456,7 @@
1.460
1.461 Line 2083 - Query standalone 0
1.462
1.463 - In paranoid mode (see -x) only, gutcheck warns about the digit 0
1.464 + In paranoid mode (see -x) only, bookloupe warns about the digit 0
1.465 and the number 1 standing alone as a word. This can happen if the
1.466 OCR misreads the words O or I.
1.467
1.468 @@ -470,7 +464,7 @@
1.469
1.470 Line 2115 - Query word whetber
1.471
1.472 - If you have switched typo-checking on, gutcheck looks for
1.473 + If you have switched typo-checking on, bookloupe looks for
1.474 potential typos, especially common h/b errors. It's not
1.475 infallible; it sometimes queries legit words, but it's
1.476 always worth taking a look.
1.477 @@ -504,10 +498,9 @@
1.478
1.479 Line 2385 column 27 - Wrongspaced quotes?
1.480
1.481 - As of version 0.98, gutcheck adds extra checks on whether a quote
1.482 - seems to be a start or end quote, and queries those that appear to
1.483 - be misplaced. This does give rise to false positives when quotes are
1.484 - nested, for example:
1.485 + Bookloupe checks whether a quote seems to be a start or end quote,
1.486 + and queries those that appear to be misplaced. This does give rise
1.487 + to false positives when quotes are nested, for example:
1.488
1.489 "And how," she asked, "will your "friends" help you now?"
1.490
1.491 @@ -540,14 +533,14 @@
1.492
1.493 Line 2540 - Mismatched quotes
1.494
1.495 - Another gutcheck mainstay - unclosed doublequotes in a paragraph.
1.496 + Another bookloupe mainstay—unclosed doublequotes in a paragraph.
1.497 See the discussion of quotes in the switches section near the
1.498 start of this file.
1.499
1.500 - Since the mismatch doesn't occur on any one line, gutcheck quotes
1.501 + Since the mismatch doesn't occur on any one line, bookloupe quotes
1.502 the line number of the first blank line following the paragraph,
1.503 since this is the point where it reconciles the count of quotes.
1.504 - However, if gutcheck is echoing lines, that is, you haven't used
1.505 + However, if bookloupe is echoing lines, that is, you haven't used
1.506 the -e switch, it will show the _first_ line of the paragraph,
1.507 to help you find the place without using line numbers. The
1.508 offending paragraph is therefore between the quoted line and
1.509 @@ -611,36 +604,36 @@
1.510 For Windows-only users who are unfamiliar with DOS:
1.511
1.512 If you're a Windows-only user, you need to save
1.513 - gutcheck.exe into the folder (directory) where the
1.514 + bookloupe.exe into the folder (directory) where the
1.515 text file you want to check is. Let's say your
1.516 - text file is in C:\GUT, then you should save
1.517 - GUTCHECK.EXE into C:\GUT.
1.518 + text file is in C:\gut, then you should save
1.519 + bookloupe.exe into C:\gut.
1.520
1.521 - Now get to a DOS prompt. You can do this by
1.522 + Now get to a console. You can do this by
1.523 selecting the "Command Prompt" or "MS-DOS Prompt"
1.524 option that will be somewhere on your
1.525 Start/Programs menu.
1.526
1.527 - Now get into the C:\GUT directory.
1.528 - You can do this using the CD (change directory)
1.529 + Now get into the C:\gut directory.
1.530 + You can do this using the cd (change directory)
1.531 command, like this:
1.532 - CD \GUT
1.533 + cd \gut
1.534 and your prompt will change to
1.535 - C:\GUT>
1.536 + C:\gut>
1.537 so you know you're in the right place.
1.538
1.539 Now type
1.540 - gutcheck yourfile.txt
1.541 - and you'll see gutcheck's report
1.542 + bookloupe yourfile.txt
1.543 + and you'll see bookloupe's report
1.544
1.545 - By default, gutcheck prints its queries to screen.
1.546 + By default, bookloupe prints its queries to screen.
1.547 If you want to create a file of them, to edit
1.548 against the text, you can use the greater-than
1.549 sign (>) to tell it to output the report to a
1.550 file. For example, if you want its report in a
1.551 - file called QUERIES.LST, you could type
1.552 -
1.553 - gutcheck yourfile.txt > queries.lst
1.554 + file called queries.lst, you could type
1.555 +
1.556 + bookloupe yourfile.txt > queries.lst
1.557
1.558 The queries.lst file will then contain the listing
1.559 of possible formatting errors, and you can
1.560 @@ -649,7 +642,7 @@
1.561 Whatever you do, DON'T make the filename after
1.562 the greater-than sign the name of a file already
1.563 on your disk that you want to keep, because
1.564 - the greater-than sign will cause gutcheck to
1.565 + the greater-than sign will cause bookloupe to
1.566 replace any existing file of that name.
1.567
1.568 So, for example, if you have two Tolstoy files
1.569 @@ -658,85 +651,11 @@
1.570 is ever used following the greater-than sign.
1.571 To check these correctly, you might do:
1.572
1.573 - gutcheck warpeace.txt >war.lst
1.574 + bookloupe warpeace.txt > war.lst
1.575
1.576 and
1.577
1.578 - gutcheck annak.txt > annak.lst
1.579 + bookloupe annak.txt > annak.lst
1.580
1.581 separately. Then you can look at war.lst and annak.lst
1.582 - to see the gutcheck reports.
1.583 -
1.584 - * * * *
1.585 -
1.586 -
1.587 -For existing 0.98 users upgrading to 0.99:
1.588 -
1.589 - If you run on old 16-bit DOS or Windows 3.x, I'm afraid
1.590 - you're out of luck. I'm not saying it _can't_ be compiled
1.591 - to run on 16-bit, but the executable with the package is
1.592 - for Win32 only. *nix users won't notice the change at all.
1.593 -
1.594 -
1.595 - There are two new switches: -u and -d.
1.596 - See above for full rundown.
1.597 -
1.598 -
1.599 -Here's a list of the new errors:
1.600 -
1.601 - Line 1456 - Carat character?
1.602 -
1.603 - I^ve found a few.
1.604 -
1.605 -
1.606 - Line 1821 - Forward slash?
1.607 -
1.608 - Common error for italicized "I", or so /'ve found.
1.609 -
1.610 -
1.611 - Line 2139 - Query missing paragraph break?
1.612 -
1.613 - "Come here, son." "Do I _have_ to go, dad?"
1.614 - Like that. False positives in some texts. Sorry 'bout that,
1.615 - but these are often errors.
1.616 -
1.617 -
1.618 - Line 2200 - Query had/bad error?
1.619 -
1.620 - Clear enough. Doesn't catch as many as I'd like it to,
1.621 - but rarely gives false alarms.
1.622 -
1.623 -
1.624 - Line 2268 - Query punctuation after the?
1.625 -
1.626 - Some words, like "the", very rarely have punctuation
1.627 - following them. Others, like "Mrs", usually have a
1.628 - period, but never a comma. Occasional false positives.
1.629 -
1.630 -
1.631 - Line 2380 - Query possible scanno arid
1.632 -
1.633 - It found one of your user-defined typos when you
1.634 - used the -u switch.
1.635 -
1.636 -
1.637 - Line 2511 - Capital "S"?
1.638 -
1.639 - Surprisingly common specific case, like: Jane'S
1.640 -
1.641 -
1.642 - Line 3469 - endquote missing punctuation?
1.643 -
1.644 - OK. This one can really cause a lot of false positives
1.645 - in some books, but it switches itself off if it finds
1.646 - more than 20 in a text, unless you force it to list them
1.647 - all with the -v switch.
1.648 - "Hey, dad" Johnny said, "can we go now?"
1.649 - is a common punctuation-missing error.
1.650 -
1.651 -
1.652 - Line 4266 - Mismatched underscores?
1.653 -
1.654 - Like mismatched anything else!
1.655 -
1.656 -
1.657 + to see the bookloupe reports.