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 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680
|
--- a/man/man1/extract.1
+++ b/man/man1/extract.1
@@ -1,6 +1,6 @@
.\"
.\" SWISH++
-.\" extract.1
+.\" extract++.1
.\"
.\" Copyright (C) 1998 Paul J. Lucas
.\"
@@ -35,18 +35,18 @@
.if !'\\$1'0' .sp
..
.\" ---------------------------------------------------------------------------
-.TH \f3extract\fP 1 "November 1, 2002" "SWISH++"
+.TH \f3extract++\fP 1 "November 1, 2002" "SWISH++"
.SH NAME
-extract \- SWISH++ text extractor
+extract++ \- SWISH++ text extractor
.SH SYNOPSIS
-.B extract
+.B extract++
[
.I options
]
.I directory...
.I file...
.SH DESCRIPTION
-.B extract
+.B extract++
is the SWISH++ text extractor,
a utility to extract what text there is from a (mostly) binary file
(similar to the
@@ -99,7 +99,7 @@
option or the
.B ExcludeFile
variable), are extracted, i.e.,
-.B extract
+.B extract++
assumes you know what you're doing when specifying filenames in this manner.
.PP
Ordinarily, the text extracted from a file is written to another file
@@ -135,10 +135,10 @@
(See the examples in
.BR swish++.conf (5).)
.SS Character Mapping and Word Determination
-.B extract
+.B extract++
performs the same character mapping, character entity conversions,
and word determination heuristics used by
-.BR index (1)
+.BR index++ (1)
but also additionally:
.TP 4
1.
@@ -165,13 +165,13 @@
characters or longer, e.g., ``\f(CW7F454C46\fP.''
(Default is 5.)
.SS Motivation
-.B extract
+.B extract++
was developed to be able to index non-text files in proprietary formats
such as Microsoft Office documents.
There are a couple of reasons why the functionality of
-.B extract
+.B extract++
isn't simply built into
-.BR index (1):
+.BR index++ (1):
.TP 4
1.
Users who do not need to index such documents
@@ -180,7 +180,7 @@
.TP
2.
While
-.BR index (1)
+.BR index++ (1)
can uncompress files on the fly using filters also,
uncompressing them every time indexing is performed is excessive.
Text extraction, on the other hand, is done only once per file;
@@ -439,7 +439,7 @@
To extract text from all Microsoft Office files on a web server:
.cS
cd /home/www/htdocs
-extract \-v3 \-e '*.doc' \-e '*.ppt' \-e '*.xls' .
+extract++ \-v3 \-e '*.doc' \-e '*.ppt' \-e '*.xls' .
.cE
.SS Filters
(See the examples in
@@ -473,7 +473,7 @@
.TP
2.
As with
-.BR index (1),
+.BR index++ (1),
the word-determination heuristics employed are heavily geared for English.
Using SWISH++ as-is to extract files in non-English languages
is not recommended.
@@ -484,8 +484,8 @@
default configuration file name
.PD
.SH SEE ALSO
-.BR index (1),
-.BR search (1),
+.BR index++ (1),
+.BR search++ (1),
.BR strings (1),
.BR swish++.conf (5),
.BR glob (7)
--- a/man/man1/index.1
+++ b/man/man1/index.1
@@ -1,6 +1,6 @@
.\"
.\" SWISH++
-.\" index.1
+.\" index++.1
.\"
.\" Copyright (C) 2003 Paul J. Lucas
.\"
@@ -35,18 +35,18 @@
.if !'\\$1'0' .sp
..
.\" ---------------------------------------------------------------------------
-.TH \f3index\f1 1 "March 25, 2004" "SWISH++"
+.TH \f3index++\f1 1 "March 25, 2004" "SWISH++"
.SH NAME
-index \- SWISH++ indexer
+index++ \- SWISH++ indexer
.SH SYNOPSIS
-.B index
+.B index++
[
.I options
]
.I directory...
.I file...
.SH DESCRIPTION
-.B index
+.B index++
is the SWISH++ file indexer.
It indexes the specified files
and files in the specified directories;
@@ -86,7 +86,7 @@
option or the
.B ExcludeFile
variable), are indexed, i.e.,
-.B index
+.B index++
assumes you know what you're doing when specifying filenames in this manner.
.P
In any case, care must be taken not to specify files or subdirectories
@@ -159,11 +159,11 @@
(See FILTERS in
.BR swish++.conf (5).)
.SS Incremental Indexing
-In order to add words from new documents to an existing index,
+In order to add words from new documents to an existing index++,
either the entire set of documents can be reindexed
or the new documents alone can be incrementally indexed.
In many cases, reindexing everything is sufficient since
-.B index
+.B index++
is really fast.
For a very large document set, however,
this may use too many resources.
@@ -198,7 +198,7 @@
.P
Another way around this problem is to do periodic full indexing.
.SH INDEXING MODULES
-.B index
+.B index++
is written in a modular fashion
where different types of files have different indexing modules.
Currently, there are 7 modules:
@@ -307,7 +307,7 @@
.B ExcludeMeta
variables.)
Meta names can later be queried against specifically using
-.BR search (1).
+.BR search++ (1).
.TP
7.
If a \f(CWTABLE\f1 element contains a \f(CWSUMMARY\f1 attribute,
@@ -330,7 +330,7 @@
Values containing whitespace, however, must be quoted.
The specification is vague as to whether whitespace surrounding the \f(CW=\f1
is legal, but
-.B index
+.B index++
allows it.
.SS ID3 Module
ID3 tags are used to store audio meta information for MP3 files (generally).
@@ -374,7 +374,7 @@
.B ExcludeMeta
variables.)
Meta names can later be queried against specifically using
-.BR search (1).
+.BR search++ (1).
.IP ""
For ID3v1.x, the recommended fields to be indexed are:
.BR album ,
@@ -507,7 +507,7 @@
.B ExcludeMeta
variables.)
Meta names can later be queried against specifically using
-.BR search (1).
+.BR search++ (1).
.IP ""
The recommended headers to be indexed are:
.BR Bcc ,
@@ -571,7 +571,7 @@
prior to indexing since there's no point in indexing a single mailbox:
every search result would return a rank of 100 for the same file.
Therefore, the
-.BR splitmail (1)
+.BR splitmail++ (1)
utility is included in the SWISH++ distribution.
.SS Manual Module
Additional processing is done for Unix manual page files.
@@ -618,7 +618,7 @@
.B ExcludeMeta
variables.)
Meta names can later be queried against specifically using
-.BR search (1).
+.BR search++ (1).
.IP ""
The recommended sections to be indexed are:
.BR AUTHOR ,
@@ -810,9 +810,9 @@
.ns
.TP
.B \-\-incremental
-Incrementally add the indexed files and words to an existing index.
-The existing index is not touched;
-instead, a new index is created having the same pathname of the existing index
+Incrementally add the indexed files and words to an existing index++.
+The existing index++ is not touched;
+instead, a new index is created having the same pathname of the existing index++
with ``\f(CW.new\f1'' appended.
.TP
.B \-l
@@ -1016,7 +1016,7 @@
.BI \-\-word-threshold= n
The word count past which partial indices are generated and merged
since all the words are too big to fit into memory at the same time.
-If you index and your machine begins to swap like mad,
+If you index++ and your machine begins to swap like mad,
lower this value.
Only the super-user can specify a value larger
than the compiled-in default.
@@ -1170,11 +1170,11 @@
.P
To index all HTML and text files on a web server:
.cS
-index \-v3 \-e 'html:*.*htm*' \-e 'text:*.txt' .
+index++ \-v3 \-e 'html:*.*htm*' \-e 'text:*.txt' .
.cE
To index all files not under directories named \f(CWCVS\f1:
.cS
-find . \-name CVS \-prune \-o \-type f \-a \-print | index \-e 'html:*.*htm*' \-
+find . \-name CVS \-prune \-o \-type f \-a \-print | index++ \-e 'html:*.*htm*' \-
.cE
.SS Windows Command-Lines
When using the Windows command interpreter,
@@ -1182,7 +1182,7 @@
.I must
use double quotes:
.cS
-index \-v3 \-e "html:*.*htm*" \-e "text:*.txt" .
+index++ \-v3 \-e "html:*.*htm*" \-e "text:*.txt" .
.cE
This is a problem with Windows, not SWISH++.
(Double quotes will also work under Unix.)
@@ -1293,7 +1293,7 @@
.TP
2.
The word-determination heuristics employed are heavily geared for English.
-Using SWISH++ as-is to index and search files in non-English languages
+Using SWISH++ as-is to index and search++ files in non-English languages
is not recommended.
.TP
3.
@@ -1336,11 +1336,11 @@
.B TempDirectory
variable.
.SH SEE ALSO
-.BR extract (1),
+.BR extract++ (1),
.BR find (1),
.BR nroff (1),
-.BR search (1),
-.BR splitmail (1),
+.BR search++ (1),
+.BR splitmail++ (1),
.BR swish++.conf (5),
.BR glob (7),
.BR man (7).
--- a/man/man1/search.1
+++ b/man/man1/search.1
@@ -1,6 +1,6 @@
.\"
.\" SWISH++
-.\" search.1
+.\" search++.1
.\"
.\" Copyright (C) 2003 Paul J. Lucas
.\"
@@ -35,22 +35,22 @@
.if !'\\$1'0' .sp
..
.\" ---------------------------------------------------------------------------
-.TH \f3search\fP 1 "June 16, 2005" "SWISH++"
+.TH \f3search++\fP 1 "June 16, 2005" "SWISH++"
.SH NAME
-search \- SWISH++ searcher
+search++ \- SWISH++ searcher
.SH SYNOPSIS
-.B search
+.B search++
[
.I options
]
.I query
.SH DESCRIPTION
-.B search
+.B search++
is the SWISH++ searcher.
-It searches a previously generated index for the words specified in a query.
+It searches a previously generated index for the words specified in a query.
In addition to running from the command-line,
it can run as a daemon process
-functioning as a ``search server.''
+functioning as a ``search++ server.''
.SH QUERY INPUT
.SS Query Syntax
The formal grammar of a query is:
@@ -120,7 +120,7 @@
see the EXAMPLES.
.SS Character Mapping and Word Determination
The same character mapping and word determination heuristics used by
-.BR index (1)
+.BR index++ (1)
are used on queries prior to searching.
.SH RESULTS OUTPUT
.SS Result Components
@@ -224,7 +224,7 @@
.cE 0
.SH RUNNING AS A DAEMON PROCESS
.SS Description
-.B search
+.B search++
can alternatively run as a daemon process
(via either the
.B \-b
@@ -233,7 +233,7 @@
options or the
.B SearchDaemon
variable)
-functioning as a ``search server''
+functioning as a ``search++ server''
by listening to a Unix domain socket
(specified by either the
.B \-u
@@ -267,7 +267,7 @@
.SS Clients and Requests
Search clients connect to a daemon via a socket
and send a query in the same manner as on the command line
-(including the first word being ``\f(CWsearch\f1'').
+(including the first word being ``\f(CWsearch++\f1'').
The only exception is that shell meta-characters
.I "must not"
be escaped (backslashed) since no shell is involved.
@@ -322,7 +322,7 @@
variable.)
.SS Restrictions
A single daemon can search only a single index.
-To search multiple indices concurrently,
+To search++ multiple indices concurrently,
multiple daemons can be run,
each searching its own index and using its own socket.
An index
@@ -430,7 +430,7 @@
.B ""
By default,
if executed from the command-line,
-.B search
+.B search++
appears to return immediately;
however, it has merely
detached from the terminal
@@ -482,7 +482,7 @@
.br
.ns
.TP
-.B \-\-dump-index
+.B \-\-dump-index++
Dump the entire word index to standard output and exit.
.TP
.BI \-F f
@@ -551,7 +551,7 @@
.BI \-\-socket-timeout= s
The number of seconds,
.IR s ,
-a search client has to complete a query request
+a sarch client has to complete a query request
before the socket connection is closed.
(Default is 10.)
This is to prevent a client from connecting, not completing a request,
@@ -584,7 +584,7 @@
.TP
.BI \-\-pid-file= f
The name of the file to record the process ID of
-.B search
+.B search++
if running as a daemon.
(Default is none.)
.TP
@@ -713,7 +713,7 @@
This option is available only under Mac OS X,
should be used only for version 10.4 (Tiger) or later,
and only when
-.B search
+.B search++
will be started via
.BR launchd (8).
.SH CONFIGURATION FILE
@@ -991,7 +991,7 @@
that would have additionally required both ``stephen'' and ``hawking''
to be near ``hole'' or ``holes.''
.SS Sending Queries to a Search Daemon
-To send a query request to a search daemon using Perl,
+To send a query request to a sarch daemon using Perl,
first open the socket and connect to the daemon
(see [Wall], pp. 439-440):
.cS
@@ -1014,7 +1014,7 @@
select( (select( SEARCH ), $| = 1)[0] );
.cE
Next, send a query request
-(beginning with the word ``search''
+(beginning with the word ``search++''
and any options just as with a command-line)
to the daemon via the socket filehandle
making sure to include a trailing newline
@@ -1022,7 +1022,7 @@
(so therefore it looks and waits for a newline):
.cS
$query = 'mouse and computer';
-print SEARCH "search $query\\n";
+print SEARCH "search++ $query\\n";
.cE
Finally, read the results back and print them:
.cS
@@ -1051,7 +1051,7 @@
Malformed query.
.TP
51
-Attempted ``near'' search without word-position data.
+Attempted ``near'' search++ without word-position data.
.TP
60
Could not write to PID file.
@@ -1139,7 +1139,7 @@
.TP
2.
When run as a daemon using a TCP socket,
-there are no security restrictions on who may connect and search.
+there are no security restrictions on who may connect and search++.
The code to implement domain and IP address restrictions
isn't worth it since such things are better handled by firewalls and routers.
.TP
@@ -1156,7 +1156,7 @@
default index file name
.PD
.SH SEE ALSO
-.BR index (1),
+.BR index++ (1),
.BR perlfunc (1),
.BR exec (2),
.BR fork (2),
--- a/man/man1/splitmail.1
+++ b/man/man1/splitmail.1
@@ -1,6 +1,6 @@
.\"
.\" SWISH++
-.\" splitmail.1
+.\" splitmail++.1
.\"
.\" Copyright (C) 2000 Paul J. Lucas
.\"
@@ -35,21 +35,20 @@
.if !'\\$1'0' .sp
..
.\" ---------------------------------------------------------------------------
-.TH \f3splitmail\f1 1 "December 13, 2000" "SWISH++"
+.TH \f3splitmail++\f1 1 "December 13, 2000" "SWISH++"
.SH NAME
-splitmail \- split mailbox files prior to indexing
+splitmail++ \- split mailbox files prior to indexing
.SH SYNOPSIS
-.B splitmail \-p
-.I prefix
+.B splitmail++ \-p\fIprefix
.BI "[ " file " ]"
.SH DESCRIPTION
-.B splitmail
+.B splitmail++
is a utility to split a mailbox file
(or standard input)
comprised of multiple messages
into multiple files of individual messages
to facilitate indexing with
-.BR index (1).
+.BR index++ (1).
The generated files have 5-digit increasing numbers
appended to a common prefix.
.SH OPTIONS
@@ -59,7 +58,7 @@
.SH EXAMPLE
The command:
.cS
-splitmail \-p msg sent_messages
+splitmail++ \-p msg sent_messages
.cE
splits the mailbox \f(CWsent_messages\f1 into files named
\f(CWmsg.00001\f1,
@@ -68,7 +67,7 @@
.SH NOTE
This utility hasn't been exhaustively tested.
.SH SEE ALSO
-.BR index (1).
+.BR index++ (1).
.SH AUTHOR
Paul J. Lucas
.RI < pauljlucas@mac.com >
--- a/man/man1/httpindex.1
+++ b/man/man1/httpindex.1
@@ -51,7 +51,7 @@
.SH DESCRIPTION
.B httpindex
is a front-end for
-.BR index (1)
+.BR index++ (1)
to index files copied from remote servers using
.BR wget (1).
The files (in a copy of the remote directory structure)
@@ -80,7 +80,7 @@
.SS httpindex Options
.B httpindex
accepts the same short options as
-.BR index (1)
+.BR index++ (1)
except for
.BR \-H ,
.BR \-I ,
@@ -124,7 +124,7 @@
non-zero otherwise.
.SH CAVEATS
In addition to those for
-.BR index (1),
+.BR index++ (1),
.B httpindex
does not correctly handle the use of multiple
.BR \-e ,
@@ -148,7 +148,7 @@
httpindex \-e'html:*.html,text:*.txt'
.cE
.SH SEE ALSO
-.BR index (1),
+.BR index++ (1),
.BR wget (1),
.BR WWW (3)
.SH AUTHOR
--- a/man/man4/swish++.conf.4
+++ b/man/man4/swish++.conf.4
@@ -330,9 +330,9 @@
mean that a file will be filtered
and subsequently indexed or extracted.
When
-.B index
+.B index++
or
-.B extract
+.B extract++
encounters a file having an extension for which a filter has been specified,
it performs the filename substitution(s) on it first
to determine what the target filename would be.
@@ -378,7 +378,7 @@
Patterns can be useful for MIME types.
For example:
.cS
-FilterAttachment application/*word extract \-f %f > @%F.txt
+FilterAttachment application/*word extract++ \-f %f > @%F.txt
.cE
can be used regardless of whether the MIME type is
\f(CWapplication/msword\f1 (the official MIME type for Microsoft Word documents)
@@ -386,7 +386,7 @@
\f(CWapplication/vnd.ms-word\f1 (an older version).
.PP
The MIME types that are built into
-.BR index (1)
+.BR index++ (1)
are:
\f(CWtext/plain\f1,
\f(CWtext/enriched\f1 (but only if the RTF module is compiled in),
@@ -410,12 +410,12 @@
.SH SEE ALSO
.BR bzip (1),
.BR compress (1),
-.BR extract (1),
+.BR extract++ (1),
.BR gunzip (1),
.BR gzip (1),
-.BR index (1),
+.BR index++ (1),
.BR pdftotext (1),
-.BR search (1),
+.BR search++ (1),
.BR uncompress (1),
.BR glob (7)
.PP
--- a/man/man4/swish++.index.4
+++ b/man/man4/swish++.index.4
@@ -55,7 +55,7 @@
.ft 2
word index
stop-word index
- directory index
+ directory index++
file index
meta-name index
.ft 1
@@ -71,7 +71,7 @@
pointing at the first character of a stop-word entry;
similarly,
every \f(CWdirectory_offset\f1 is an offset into the
-.I "directory index"
+.I "directory index++"
pointing at the first character of a directory entry;
similarly,
every \f(CWfile_offset\f1 is an offset into the
@@ -79,7 +79,7 @@
pointing at the first byte of a file entry;
finally,
every \f(CWmeta_name_offset\f1 is an offset into the
-.I "mete-name index"
+.I "meta-name index"
pointing at the first character of a meta-name entry.
.P
The index file is written as it is so that it can be mapped into memory via the
@@ -197,7 +197,7 @@
that is: every word is null-terminated.
.SS Directory Entries
Every directory entry in the
-.I "directory index"
+.I "directory index++"
is of the form:
.cS
\f2directory-path\fP0
@@ -213,7 +213,7 @@
.cS
\f3\s+2{\s-2\fP\f2D\fP\f3\s+2}\s-2\fP\f2file-name\fP0\f3\s+2{\s-2\fP\f2S\fP\f3\s+2}{\s-2\fP\f2W\fP\f3\s+2}\s-2\fP\f2file-title\fP0
.cE
-that is: the file's directory index
+that is: the file's directory index++
.RI ( D )
followed by a null-terminated file name
followed by the file's size in bytes
@@ -247,8 +247,8 @@
Generated index files are machine-dependent
(size of data types and byte-order).
.SH SEE ALSO
-.BR index (1),
-.BR search (1)
+.BR index++ (1),
+.BR search++ (1)
.SH AUTHOR
Paul J. Lucas
.RI < pauljlucas@mac.com >
|