X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=Documentation%2Flei-add-external.pod;h=7afcad637f7317044a2409c75341dd8f7074d90a;hb=refs%2Fheads%2Fmaster;hp=3bc0ba83159671f0982f99061b8d1a7c56429833;hpb=f310a5054fb8e215885f0b48afac44ff32ca1d56;p=public-inbox.git diff --git a/Documentation/lei-add-external.pod b/Documentation/lei-add-external.pod index 3bc0ba83..2a131b55 100644 --- a/Documentation/lei-add-external.pod +++ b/Documentation/lei-add-external.pod @@ -10,11 +10,12 @@ lei add-external [OPTIONS] LOCATION Configure lei to search against an external (an inbox or external 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. +to a directory that is a C or +C value in ~/.public-inbox/config. =head1 OPTIONS +=for comment TODO: mention curl options? =over @@ -28,12 +29,33 @@ Default: 0 =item --mirror=URL Create C by mirroring the public-inbox at C. +C will have a Makefile with a C +target to update the external. -=item -v, --verbose +=item --epoch=RANGE + +Restrict clones of L inboxes to the +given range of epochs. The range may be a single non-negative +integer or a (possibly open-ended) C range of +non-negative integers. C<~> may be prefixed to either (or both) +integer values to represent the offset from the maximum possible +value. + +For example, C<--epoch=~0> alone clones only the latest epoch, +C<--epoch=~2..> clones the three latest epochs. + +Default: C<0..~0> or C<0..> or C<..~0> +(all epochs, all three examples are equivalent) + +=item -v + +=item --verbose Provide more feedback on stderr. -=item -q, --quiet +=item -q + +=item --quiet Suppress feedback messages. @@ -43,15 +65,19 @@ Suppress feedback messages. =over -=item --torsocks=auto|no|yes, --no-torsocks +=item --torsocks=auto|no|yes + +=item --no-torsocks -Whether to wrap L and L commands with torsocks. +Whether to wrap L and L commands with L. Default: C =item --inbox-version=NUM -Force a public-inbox version (must be C<1> or C<2>). +Force a remote public-inbox version (must be C<1> or C<2>). +This is auto-detected by default, and this option exists mainly +for testing. =back @@ -91,8 +117,8 @@ The configuration for lei resides at C<$XDG_CONFIG_HOME/lei/config>. Feedback welcome via plain-text mail to L -The mail archives are hosted at L -and L +The mail archives are hosted at L and +L =head1 COPYRIGHT