From: Kyle Meyer Date: Thu, 11 Feb 2021 04:04:15 +0000 (-0500) Subject: doc: lei: update manpages X-Git-Tag: v1.7.0~1128 X-Git-Url: http://www.git.stargrave.org/?a=commitdiff_plain;h=f310a5054fb8e215885f0b48afac44ff32ca1d56;p=public-inbox.git doc: lei: update manpages Catch up with recent developments. --- diff --git a/Documentation/lei-add-external.pod b/Documentation/lei-add-external.pod index 1be3f905..3bc0ba83 100644 --- a/Documentation/lei-add-external.pod +++ b/Documentation/lei-add-external.pod @@ -9,12 +9,14 @@ lei add-external [OPTIONS] LOCATION =head1 DESCRIPTION Configure lei to search against an external (an inbox or external -index). When C is a local path, it should point to a -directory that is a C.inboxdir> or +index). When C is an existing local path, it should point +to a directory that is a C.inboxdir> or C.topdir> value in ~/.public-inbox/config. =head1 OPTIONS +TODO: mention curl options? + =over =item --boost=NUMBER @@ -23,6 +25,62 @@ Set priority of a new or existing location. Default: 0 +=item --mirror=URL + +Create C by mirroring the public-inbox at C. + +=item -v, --verbose + +Provide more feedback on stderr. + +=item -q, --quiet + +Suppress feedback messages. + +=back + +=head2 MIRRORING + +=over + +=item --torsocks=auto|no|yes, --no-torsocks + +Whether to wrap L and L commands with torsocks. + +Default: C + +=item --inbox-version=NUM + +Force a public-inbox version (must be C<1> or C<2>). + +=back + +The following options are passed to L: + +=over + +=item -j JOBS, --jobs=JOBS + +=item -L LEVEL, --indexlevel=LEVEL + +=back + +The following options are passed to L: + +=over + +=item --batch-size=SIZE + +=item --compact + +=item -j JOBS, --jobs=JOBS + +=item --max-size=SIZE + +=item --sequential-shard + +=item --skip-docdata + =back =head1 FILES diff --git a/Documentation/lei-ls-external.pod b/Documentation/lei-ls-external.pod index 1735faa9..85d951f0 100644 --- a/Documentation/lei-ls-external.pod +++ b/Documentation/lei-ls-external.pod @@ -4,16 +4,29 @@ lei-ls-external - list inbox and external index locations =head1 SYNOPSIS -lei ls-external [OPTIONS] +lei ls-external [OPTIONS] [FILTER] =head1 DESCRIPTION -List configured externals. +List configured externals. If C is given, restrict the output +to matching entries. =head1 OPTIONS =over +=item -g, --globoff + +Do not match C using C<*?> wildcards and C<[]> ranges. + +=item --local + +Limit operations to the local filesystem. + +=item --remote + +Limit operations to those requiring network access. + =item -z, -0 Use C<\0> (NUL) instead of newline (CR) to delimit lines. diff --git a/Documentation/lei-overview.pod b/Documentation/lei-overview.pod index 33ddb528..840d011b 100644 --- a/Documentation/lei-overview.pod +++ b/Documentation/lei-overview.pod @@ -27,7 +27,7 @@ Import the messages from an mbox into the local storage. In addition to the above store, lei can make read-only queries to "externals": inboxes and external indices. An external can be registered by passing a URL or local path to L. -For local paths, the external needs to be indexed with +For existing local paths, the external needs to be indexed with L (in the case of a regular inbox) or L (in the case of an external index). @@ -39,6 +39,11 @@ L (in the case of an external index). Add a remote external for public-inbox's inbox. +=item $ lei add-external --mirror https://public-inbox.org/meta/ path + +Clone L to C, index it with +L, and add it as a local external. + =back =head1 SEARCHING diff --git a/Documentation/lei-q.pod b/Documentation/lei-q.pod index 405cf48f..c8df6fc7 100644 --- a/Documentation/lei-q.pod +++ b/Documentation/lei-q.pod @@ -6,6 +6,8 @@ lei-q - search for messages matching terms lei q [OPTIONS] TERM [TERM...] +lei q [OPTIONS] --stdin + =head1 DESCRIPTION Search for messages across the lei store and externals. @@ -14,8 +16,14 @@ TODO: Give common prefixes, or at least a description/reference. =head1 OPTIONS +TODO: mention curl options? + =over +=item --stdin + +Read search terms from stdin. + =item -o MFOLDER, --output=MFOLDER, --mfolder=MFOLDER Destination for results (e.g., C or - for stdout). @@ -43,6 +51,18 @@ For a subset of MUAs known to accept a mailbox via C<-f>, COMMAND can be abbreviated to the name of the program: C, C, C, or C. +=item --alert=COMMAND[,COMMAND...] + +Run C after writing to output. C<:WINCH> indicates to send +C to the C<--mua> process. C<:bell> indicates to print a +bell code. Any other value is interpreted as a command to execute as +is. + +This option may be given multiple times. + +Default: C<:WINCH,:bell> when C<--mua> is specified and C<--output> +doesn't point to stdout, nothing otherwise. + =item -a, --augment Augment output destination instead of clobbering it. @@ -74,6 +94,26 @@ Limit operations to those requiring network access. Don't include results from externals. +=item -I LOCATION, --include=LOCATION + +Include specified external in search. This option may be given +multiple times. + +=item --exclude=LOCATION + +Exclude specified external from search. This option may be given +multiple times. + +=item --only=LOCATION + +Use only the specified external for search. This option may be given +multiple times, in which case the search uses only the specified set. + +=item -g, --globoff + +Do not match locations using C<*?> wildcards and C<[]> ranges. This +option applies to C<--include>, C<--exclude>, and C<--only>. + =item -NUMBER, -n NUMBER, --limit=NUMBER Limit the number of matches. @@ -101,6 +141,10 @@ Default: C Provide more feedback on stderr. +=item -q, --quiet + +Suppress feedback messages. + =item --torsocks=auto|no|yes, --no-torsocks Whether to wrap L and L commands with torsocks.