X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=Documentation%2Flei-q.pod;h=574c12eb9d3a36883063fc5a05c6b793cec2698c;hb=44812cbbec44625083b6e5441a798a21a5e79f71;hp=46884aa5c875488c5a7773b75461c1ade843833f;hpb=0b15dfc58ceaecdcb1c9285c3ad55813006c8338;p=public-inbox.git diff --git a/Documentation/lei-q.pod b/Documentation/lei-q.pod index 46884aa5..574c12eb 100644 --- a/Documentation/lei-q.pod +++ b/Documentation/lei-q.pod @@ -10,7 +10,7 @@ lei q [OPTIONS] (--stdin|-) =head1 DESCRIPTION -Search for messages across the lei store and externals. +Search for messages across the lei/store and externals. =for comment TODO: Give common prefixes, or at least a description/reference. @@ -26,6 +26,10 @@ TODO: mention curl options? Read search terms from stdin. +=item --no-save + +Do not save the search for L. + =item --output=MFOLDER =item -o MFOLDER @@ -39,7 +43,7 @@ Destination for results (e.g., C, C, or C). The prefix may be a supported protocol: C or C. URLs requiring -authentication must use L and/or L to +authentication use L to fill in the username and password. A prefix can specify the format of the output: C, @@ -56,7 +60,7 @@ Default: C<-> (stdout) Format of results to stdout. This option exists as a convenient way to specify the format for the default stdout destination. -C, C, C, or C are all supported, +C, C, C, C, or C are all supported, as are the various mbox variants described in L. When a format isn't specified, it's chosen based on the @@ -66,6 +70,10 @@ default destination (stdout). Using a C prefix with the C<--output> destination is preferred when not writing to stdout. +=item --no-color + +Disable color (for C<-f reply> and C<-f text>). + =item --pretty Pretty print C or C output. If stdout is opened to @@ -99,7 +107,7 @@ Augment output destination instead of clobbering it. =item --no-import-before -Do not importing keywords before writing to an existing output +Do not import keywords before writing to an existing output destination. =item --threads @@ -156,6 +164,8 @@ multiple times. =item --only=LOCATION +=item -O 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. @@ -171,7 +181,7 @@ option applies to C<--include>, C<--exclude>, and C<--only>. Disable the default behavior of memoizing remote messages into the local store. -=item --lock +=item --lock=METHOD L locking method(s) to use: C, C, C or C. @@ -184,7 +194,9 @@ Default: fcntl,dotlock =item -n NUMBER -Limit the number of matches. +Fuzzy limit the number of matches per-local external and lei/store. +Messages added by the L<--threads> switch do not count towards this +limit, and there is no limit on remote externals. Default: 10000 @@ -229,8 +241,17 @@ Whether to wrap L and L commands with torsocks. Default: C +=item --proxy=PROTO://HOST[:PORT] + =back +=head1 TIPS + +C<-f reply> is intended to aid in turning a cover letter +into a reply (since using C +is tedious). Results (including "From " lines) should be edited +and trimmed in your favorite C<$EDITOR> before sending. + =head1 CONTACT Feedback welcome via plain-text mail to L @@ -246,5 +267,5 @@ License: AGPL-3.0+ L =head1 SEE ALSO -L, +L, L, L, L