From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on dcvr.yhbt.net X-Spam-Level: X-Spam-Status: No, score=-3.3 required=3.0 tests=AWL,BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_MSPIKE_H4, RCVD_IN_MSPIKE_WL,SPF_HELO_NONE,SPF_PASS shortcircuit=no autolearn=ham autolearn_force=no version=3.4.2 Received: from out2.migadu.com (out2.migadu.com [188.165.223.204]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by dcvr.yhbt.net (Postfix) with ESMTPS id DC0AE1F9FE for ; Sat, 27 Feb 2021 18:03:41 +0000 (UTC) X-Report-Abuse: Please report any abuse attempt to abuse@migadu.com and include these headers. DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=kyleam.com; s=key1; t=1614449019; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=nuyITd5lky3Lf+1s9JnmFd3v3S71EajXyek4RGI+fmw=; b=gcFfVkhVKiQj6xb4ZKSdlUsAfu9q10ah/0SSbH3h/VazyPeYI5dZaejulDqzpj9vdUDT8Q Yc//U05aqmGOIbtBo3NElDu76yZLgGPUk+c6iMfs/OaszbncqT0nv+rA0jRa1Z4GVcuzog 8rlZfiMAxhoXmvIDzrxXe9J8leul2maUYYVMsRlVk4xI8DszQEPNsjG25QxPCB5vPRCJjg 7ubN+2/T6nrV8KuE1rcLAKXu19PuRZ/nIm1mkZWUU+qh1ubVH8Zk78qT+97eNfIpf7m3Ga Yt8R9DLUepp8R9iMWb7PqTVy9G9YLDG0zgttvqVc3QUgkmnn8BtKTrnZmBWGeQ== From: Kyle Meyer To: meta@public-inbox.org Subject: [PATCH 1/3] doc: lei: update manpages Date: Sat, 27 Feb 2021 13:03:26 -0500 Message-Id: <20210227180328.28057-2-kyle@kyleam.com> In-Reply-To: <20210227180328.28057-1-kyle@kyleam.com> References: <20210227180328.28057-1-kyle@kyleam.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Migadu-Flow: FLOW_OUT X-Migadu-Auth-User: kyle@kyleam.com List-Id: Catch up with recent developments. --- Documentation/lei-import.pod | 19 ++++++++++++++----- Documentation/lei-q.pod | 32 ++++++++++++++++++++++++-------- Documentation/lei.pod | 15 ++++++++++++++- Documentation/txt2pre | 1 + 4 files changed, 53 insertions(+), 14 deletions(-) diff --git a/Documentation/lei-import.pod b/Documentation/lei-import.pod index ef20e2f6305cf6ff..7d5b2576808fdb61 100644 --- a/Documentation/lei-import.pod +++ b/Documentation/lei-import.pod @@ -11,12 +11,14 @@ lei import [OPTIONS] --stdin =head1 DESCRIPTION Import messages into the local storage of L. C is a -source of messages: a directory (Maildir) or a file. For a regular -file, the location must have a CformatE:> prefix specifying -one of the following formats: C, C, C, -C, or C. +source of messages: a directory (Maildir), a file, or a URL +(C, C, C, or C). URLs requiring +authentication must use L and/or L to +fill in the username and password. -TODO: Update when URL support is added. +For a regular file, the location must have a CformatE:> +prefix specifying one of the following formats: C, C, +C, C, or C. =head1 OPTIONS @@ -31,6 +33,13 @@ format prefix with C is preferred. Read messages from stdin. +=item --lock + +L locking method(s) to use: C, C, C or +C. + +Default: fcntl,dotlock + =item --no-kw, --no-keywords, --no-flags Don't import message keywords (or "flags" in IMAP terminology). diff --git a/Documentation/lei-q.pod b/Documentation/lei-q.pod index 0959beac38504841..e878157d93e2f7c5 100644 --- a/Documentation/lei-q.pod +++ b/Documentation/lei-q.pod @@ -26,18 +26,22 @@ Read search terms from stdin. =item -o MFOLDER, --output=MFOLDER, --mfolder=MFOLDER -Destination for results (e.g., C or -C). The format can be specified by adding a -CformatE:> prefix with any of these values: C, +Destination for results (e.g., C, +C, or +C). The prefix may be a supported protocol: +C, C, C, or C. URLs requiring +authentication must use L and/or L to +fill in the username and password. + +The prefix can instead specify the format of the output: C, C, C, C, C, C, C, or -C. +C. When a format isn't specified, it's chosen based on +the destination. C is used for the default destination +(stdout), and C is used for an existing directory or +non-existing path. TODO: Provide description of formats? -When a format isn't specified, it's chosen based on the destination. -C is used for the default destination (stdout), and C -is used for an existing directory or non-existing path. - Default: - =item -f FORMAT, --format=FORMAT @@ -130,6 +134,18 @@ multiple times, in which case the search uses only the specified set. Do not match locations using C<*?> wildcards and C<[]> ranges. This option applies to C<--include>, C<--exclude>, and C<--only>. +=item --no-import-remote + +Disable the default behavior of memoizing remote messages into the +local store. + +=item --lock + +L locking method(s) to use: C, C, C or +C. + +Default: fcntl,dotlock + =item -NUMBER, -n NUMBER, --limit=NUMBER Limit the number of matches. diff --git a/Documentation/lei.pod b/Documentation/lei.pod index 9ce9e9a4dc6cde81..e1502122571ad521 100644 --- a/Documentation/lei.pod +++ b/Documentation/lei.pod @@ -4,7 +4,7 @@ lei - local email interface for public-inbox =head1 SYNOPSIS -lei COMMAND +lei [OPTIONS] COMMAND =head1 DESCRIPTION @@ -19,6 +19,19 @@ indices). Available in public-inbox 1.7.0+. +=head1 OPTIONS + +=over + +=item -C DIR + +Change current working directory to the specified directory before +running the command. This option can be given before or after +C and is accepted by all lei subcommands except +L. + +=back + =head1 COMMANDS Subcommands for initializing and managing local, writable storage: diff --git a/Documentation/txt2pre b/Documentation/txt2pre index 8421cad74e7b4321..3277531f9122b8d6 100755 --- a/Documentation/txt2pre +++ b/Documentation/txt2pre @@ -102,6 +102,7 @@ $xurls{'git-filter-repo(1)'} = 'https://github.com/newren/git-filter-repo'. $xurls{'ssoma(1)'} = 'https://ssoma.public-inbox.org/ssoma.txt'; $xurls{'cgitrc(5)'} = 'https://git.zx2c4.com/cgit/tree/cgitrc.5.txt'; $xurls{'prove(1)'} = 'https://perldoc.perl.org/prove.html'; +$xurls{'mbox(5)'} = 'https://manpages.debian.org/stable/mutt/mbox.5.en.html'; my $str = do { local $/; }; my ($title) = ($str =~ /\A([^\n]+)/); -- 2.30.1