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.2 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,SPF_HELO_NONE,SPF_PASS shortcircuit=no autolearn=ham autolearn_force=no version=3.4.2 Received: from out0.migadu.com (out0.migadu.com [IPv6:2001:41d0:2:267::]) (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 8638C1F9FF for ; Thu, 11 Feb 2021 04:04:40 +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=1613016277; 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=47TrDsRnijI7HnM65GLZE/pkAtrvXPFBHx7Tap38AwI=; b=N0wqGGRAHCzAQUIJV4lpwBkvLFv2mfZW7NuYJC+l4cMzhSGc7WcI+LlWTJaOZfIZ0x3b+5 zmhORj/2ZDrLs2oiElKLJ67yxRObx3+Oz8oqiQxOBNtvPnVWKwJQ9oF/9TMWuTsJlGPOs/ fzLa43pexxZGbFP6mC9Qw/r6yVKVugv8RtoBNBRqjkaPR152n73jHBFgYgsLYJTuCV32mW zlnFqqxMDqft/X7wJiDdaGW5y4juhI4ZUAl2ejCsRU8X50HJnOxhaTGW507BLPXVv6K7MA 1QSoPrXd6bTjpLhoDoOrs+PTUm3RxtbLhYieZb3sPU+8qJcJnZw5xEUbnKw6TQ== From: Kyle Meyer To: meta@public-inbox.org Subject: [PATCH 3/4] doc: add lei-import(1) Date: Wed, 10 Feb 2021 23:04:14 -0500 Message-Id: <20210211040415.28557-4-kyle@kyleam.com> In-Reply-To: <20210211040415.28557-1-kyle@kyleam.com> References: <20210211040415.28557-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: --- Documentation/lei-add-external.pod | 2 +- Documentation/lei-import.pod | 54 ++++++++++++++++++++++++++++++ Documentation/lei-overview.pod | 10 +++++- Documentation/lei.pod | 4 +-- Documentation/txt2pre | 1 + MANIFEST | 1 + Makefile.PL | 2 +- 7 files changed, 69 insertions(+), 5 deletions(-) create mode 100644 Documentation/lei-import.pod diff --git a/Documentation/lei-add-external.pod b/Documentation/lei-add-external.pod index ebefb4cf..1be3f905 100644 --- a/Documentation/lei-add-external.pod +++ b/Documentation/lei-add-external.pod @@ -44,6 +44,6 @@ License: AGPL-3.0+ L =head1 SEE ALSO -L, L, +L, L, L, L, L, L diff --git a/Documentation/lei-import.pod b/Documentation/lei-import.pod new file mode 100644 index 00000000..14ca2d45 --- /dev/null +++ b/Documentation/lei-import.pod @@ -0,0 +1,54 @@ +=head1 NAME + +lei-import - one-time import of messages into local store + +=head1 SYNOPSIS + +lei import [OPTIONS] LOCATION [LOCATION...] + +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 (whose format is +specified via C<--format>). + +TODO: Update when URL support is added. + +=head1 OPTIONS + +=over + +=item -f MAIL_FORMAT, --format=MAIL_FORMAT + +Message input format: C, C, C, C, +C. + +=item --stdin + +Read messages from stdin. + +=item --no-kw, --no-keywords, --no-flags + +Don't import message keywords (or "flags" in IMAP terminology). + +=back + +=head1 CONTACT + +Feedback welcome via plain-text mail to L + +The mail archives are hosted at L +and L + +=head1 COPYRIGHT + +Copyright 2021 all contributors L + +License: AGPL-3.0+ L + + +=head1 SEE ALSO + +L diff --git a/Documentation/lei-overview.pod b/Documentation/lei-overview.pod index d1903045..33ddb528 100644 --- a/Documentation/lei-overview.pod +++ b/Documentation/lei-overview.pod @@ -12,7 +12,15 @@ provides some basic examples. L initializes writable local storage based on L. -TODO: Extend when lei-import and friends are added. +=head2 EXAMPLES + +=over + +=item $ lei import --format=mboxrd t.mbox + +Import the messages from an mbox into the local storage. + +=back =head1 EXTERNALS diff --git a/Documentation/lei.pod b/Documentation/lei.pod index e12a157d..9ce9e9a4 100644 --- a/Documentation/lei.pod +++ b/Documentation/lei.pod @@ -27,9 +27,9 @@ Subcommands for initializing and managing local, writable storage: =item * L -=back +=item * L -TODO: Add commands like lei-import once they're implemented. +=back The following subcommands can be used to manage and inspect external locations: diff --git a/Documentation/txt2pre b/Documentation/txt2pre index 604490ef..8421cad7 100755 --- a/Documentation/txt2pre +++ b/Documentation/txt2pre @@ -16,6 +16,7 @@ for (qw[lei(1) lei-daemon-kill(1) lei-daemon-pid(1) lei-forget-external(1) + lei-import(1) lei-init(1) lei-ls-external(1) lei-overview(7) diff --git a/MANIFEST b/MANIFEST index 92226d5a..1794d930 100644 --- a/MANIFEST +++ b/MANIFEST @@ -26,6 +26,7 @@ Documentation/lei-config.pod Documentation/lei-daemon-kill.pod Documentation/lei-daemon-pid.pod Documentation/lei-forget-external.pod +Documentation/lei-import.pod Documentation/lei-init.pod Documentation/lei-ls-external.pod Documentation/lei-overview.pod diff --git a/Makefile.PL b/Makefile.PL index 6fb0d560..89f1774e 100644 --- a/Makefile.PL +++ b/Makefile.PL @@ -45,7 +45,7 @@ $v->{-m1} = [ map { } @EXE_FILES, qw( lei-add-external lei-config lei-daemon-kill lei-daemon-pid - lei-forget-external lei-init lei-ls-external lei-q)]; + lei-forget-external lei-import lei-init lei-ls-external lei-q)]; $v->{-m5} = [ qw(public-inbox-config public-inbox-v1-format public-inbox-v2-format public-inbox-extindex-format) ]; $v->{-m7} = [ qw(lei-overview public-inbox-overview public-inbox-tuning) ]; -- 2.30.0