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-ASN: AS3215 2.0.0.0/16 X-Spam-Status: No, score=-3.2 required=3.0 tests=AWL,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 out2.migadu.com (out2.migadu.com [IPv6:2001:41d0:2:aacc::]) (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 4D71E1F9F4 for ; Mon, 17 May 2021 03:35:56 +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=1621222555; 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=LHB+ZEIscbr7EC1Yxkw/xOXh42FcHlZf/pGZ3ToguHM=; b=0YJdMMdTwaKQR+5/WrV1IZcWHX+gmjjwuNrMH1usNzFVqq6f5k+jxL7WJ7dcTEBusGaebv vx3GWTUGcRUYxRzzmoSe8WOev8II9B7W74181uT2wxYYj/yIz84O3C/D8oj6lkPnMR/WlC kzOgsSCrp97Xno6GAbyfGndT50lKetre+wtELNMN7jfQsdurtQ2fFKnd8Xb4zBGnwJCInV B5XbIBujP+5pWLwxd4fTshGQ/jznIiH/m88K4gvhUSLg5wwqi/tc71dqkzxMdnJV4XmzXM r6RiRy7AErWCZTCAJlOOrsxXqDsAPeqtb9L7PnevLBRTxGPFgZa1BXXHbzN7PA== From: Kyle Meyer To: meta@public-inbox.org Subject: [PATCH 8/9] doc lei: add manpages for new commands Date: Sun, 16 May 2021 23:35:27 -0400 Message-Id: <20210517033528.18966-9-kyle@kyleam.com> In-Reply-To: <20210517033528.18966-1-kyle@kyleam.com> References: <20210517033528.18966-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-edit-search.pod | 28 ++++++++++ Documentation/lei-forget-search.pod | 28 ++++++++++ Documentation/lei-lcat.pod | 79 +++++++++++++++++++++++++++++ Documentation/lei-ls-mail-sync.pod | 55 ++++++++++++++++++++ Documentation/lei-ls-search.pod | 65 ++++++++++++++++++++++++ Documentation/lei-overview.pod | 12 +++++ Documentation/lei-q.pod | 2 +- Documentation/lei-rediff.pod | 79 +++++++++++++++++++++++++++++ Documentation/lei-up.pod | 48 ++++++++++++++++++ Documentation/lei.pod | 16 ++++++ Documentation/txt2pre | 8 +++ MANIFEST | 7 +++ Makefile.PL | 8 +-- 13 files changed, 431 insertions(+), 4 deletions(-) create mode 100644 Documentation/lei-edit-search.pod create mode 100644 Documentation/lei-forget-search.pod create mode 100644 Documentation/lei-lcat.pod create mode 100644 Documentation/lei-ls-mail-sync.pod create mode 100644 Documentation/lei-ls-search.pod create mode 100644 Documentation/lei-rediff.pod create mode 100644 Documentation/lei-up.pod diff --git a/Documentation/lei-edit-search.pod b/Documentation/lei-edit-search.pod new file mode 100644 index 00000000..7908b5a2 --- /dev/null +++ b/Documentation/lei-edit-search.pod @@ -0,0 +1,28 @@ +=head1 NAME + +lei-edit-search - edit saved search + +=head1 SYNOPSIS + +lei edit-search [OPTIONS] OUTPUT + +=head1 DESCRIPTION + +Invoke C to edit the saved search at C. + +=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, L, L, L diff --git a/Documentation/lei-forget-search.pod b/Documentation/lei-forget-search.pod new file mode 100644 index 00000000..49bc1d68 --- /dev/null +++ b/Documentation/lei-forget-search.pod @@ -0,0 +1,28 @@ +=head1 NAME + +lei-forget-search - forget saved search + +=head1 SYNOPSIS + +lei forget-search [OPTIONS] OUTPUT + +=head1 DESCRIPTION + +Forget a saved search at C. + +=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, L, L, L diff --git a/Documentation/lei-lcat.pod b/Documentation/lei-lcat.pod new file mode 100644 index 00000000..5a2bdb5a --- /dev/null +++ b/Documentation/lei-lcat.pod @@ -0,0 +1,79 @@ +=head1 NAME + +lei-lcat - display local copy of messages(s) + +=head1 SYNOPSIS + +lei lcat [OPTIONS] MSGID_OR_URL [MSGID_OR_URL...] + +lei lcat [OPTIONS] (--stdin|-) + +=head1 DESCRIPTION + +lcat (local cat) is a wrapper around L that displays local +messages by Message-ID. It is able to extract Message-IDs from URLs +as well as from common formats such as C$MSGIDE> and +C. When reading from stdin, input that isn't understood is +discarded, so the caller doesn't have to bother extracting the +Message-ID or link from surrounding text (e.g., a "Link: $URL" line). + +=head1 OPTIONS + +The following options, described in L, are supported. + +=over + +=item --[no-]remote + +=item --no-local + +=item --no-external + +=item --no-import-remote + +=item --torsocks=auto|no|yes, --no-torsocks + +=item --proxy=PROTO://HOST[:PORT] + +=item -o MFOLDER, --output=MFOLDER + +=item -d STRATEGY, --dedupe=STRATEGY + +=item -t, --threads + +=item -s KEY, --sort=KEY + +=item -r, --reverse + +=item --offset=NUMBER + +=item -g, --globoff + +=item -a, --augment + +=item --lock=METHOD + +=item --alert=COMMAND + +=item --mua=COMMAND + +=item --no-color + +=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, L diff --git a/Documentation/lei-ls-mail-sync.pod b/Documentation/lei-ls-mail-sync.pod new file mode 100644 index 00000000..37aa910f --- /dev/null +++ b/Documentation/lei-ls-mail-sync.pod @@ -0,0 +1,55 @@ +=head1 NAME + +lei-ls-mail-sync - list mail sync folders + +=head1 SYNOPSIS + +lei mail-sync [OPTIONS] [FILTER] + +=head1 DESCRIPTION + +List mail sync folders. If C is given, restrict the output to +matching entries. + +=head1 OPTIONS + +=over + +=item -g + +=item --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 + +=item -0 + +Use C<\0> (NUL) instead of newline (CR) to delimit lines. + +=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, L diff --git a/Documentation/lei-ls-search.pod b/Documentation/lei-ls-search.pod new file mode 100644 index 00000000..138dbbff --- /dev/null +++ b/Documentation/lei-ls-search.pod @@ -0,0 +1,65 @@ +=head1 NAME + +lei-ls-search - list saved search queries + +=head1 SYNOPSIS + +lei ls-search [OPTIONS] [PREFIX] + +=head1 DESCRIPTION + +List saved search queries. If C is given, restrict the output +to entries that start with the specified value. + +=head1 OPTIONS + +=over + +=item -f FORMAT + +=item --format=FORMAT + +Display JSON output rather than default short output that includes +only the saved search location. Possible values are C, +C, or C. + +=item --pretty + +Pretty print C or C output. If stdout is opened to +a tty and used as the C<--output> destination, C<--pretty> is enabled +by default. + +=item -l + +Long listing format (shortcut for C<--format=json>). + +=item --ascii + +Escape non-ASCII characters. + +=item -z + +=item -0 + +Use C<\0> (NUL) instead of newline (CR) to delimit lines. This option +is incompatible with C<--format>. + +=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, L, L, +L diff --git a/Documentation/lei-overview.pod b/Documentation/lei-overview.pod index 4a34bc16..e80cb094 100644 --- a/Documentation/lei-overview.pod +++ b/Documentation/lei-overview.pod @@ -98,6 +98,18 @@ Search for messages that have post-image git blob IDs that match those of the current repository's HEAD commit, writing them to the Maildir directory "mdir" and flagging the messages that were an exact match. +=item $ git show -s HEAD | lei lcat - + +Display a local message for the public-inbox link contained in a +commit message. + +=item $ lei q -f text m:MID | lei rediff -U5 - + +Feed a message containing a diff to L to regenerate its +diff with five context lines. Unless C<--git-dir> is specified, this +requires the current working directory to be within the associated +code repository. + =back =head1 PERFORMANCE NOTES diff --git a/Documentation/lei-q.pod b/Documentation/lei-q.pod index 39199849..c4a7eea3 100644 --- a/Documentation/lei-q.pod +++ b/Documentation/lei-q.pod @@ -246,5 +246,5 @@ License: AGPL-3.0+ L =head1 SEE ALSO -L, +L, L, L, L diff --git a/Documentation/lei-rediff.pod b/Documentation/lei-rediff.pod new file mode 100644 index 00000000..5fdde230 --- /dev/null +++ b/Documentation/lei-rediff.pod @@ -0,0 +1,79 @@ +=head1 NAME + +lei-rediff - regenerate a diff with different options + +=head1 SYNOPSIS + +lei rediff [OPTIONS] LOCATION [LOCATION...] + +lei rediff [OPTIONS] (--stdin|-) + +=head1 DESCRIPTION + +Read a message from C or stdin and regenerate its diff with +the specified L options. This is useful if you want to +change the display of the original patch (e.g., increasing context, +coloring moved lines differently, or using an external diff viewer). + +=head1 OPTIONS + +In addition to many L, the following options are +supported. + +=over + +=item --stdin + +Read message from stdin. + +=item --git-dir=DIR + +Specify an additional .git/ directory to scan. This option may be +given multiple times. + +=item --no-cwd + +Do not look in the git repository of the current working directory. + +=item -v + +=item --verbose + +Provide more feedback on stderr. + +=back + +The options below, described in L, are also supported. + +=over + +=item --[no-]remote + +=item --no-local + +=item --no-external + +=item --no-import-remote + +=item --torsocks=auto|no|yes, --no-torsocks + +=item --proxy=PROTO://HOST[:PORT] + +=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, L, L diff --git a/Documentation/lei-up.pod b/Documentation/lei-up.pod new file mode 100644 index 00000000..cea0f619 --- /dev/null +++ b/Documentation/lei-up.pod @@ -0,0 +1,48 @@ +=head1 NAME + +lei-up - update a saved search + +=head1 SYNOPSIS + +lei up [OPTIONS] OUTPUT + +lei up [OPTIONS] --all=TYPE + +=head1 DESCRIPTION + +Update the saved search at C or all saved searches of C +(currently C is the only supported value). + +=head1 OPTIONS + +The following options, described in L, are supported. + +=over + +=item --lock=METHOD + +=item --alert=CMD + +=item --mua=CMD + +This option is incompatible with C<--all>. + +=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, L, L, +L diff --git a/Documentation/lei.pod b/Documentation/lei.pod index 78e1fb1e..3af9e2ee 100644 --- a/Documentation/lei.pod +++ b/Documentation/lei.pod @@ -72,10 +72,24 @@ store and configured externals are =item * L +=item * L + +=item * L + +=item * L + +=item * L + +=item * L + =item * L =item * L +=item * L + +=item * L + =back Other subcommands include @@ -92,6 +106,8 @@ Other subcommands include =item * L +=item * L + =back =head1 FILES diff --git a/Documentation/txt2pre b/Documentation/txt2pre index 201566ee..d98dfdd3 100755 --- a/Documentation/txt2pre +++ b/Documentation/txt2pre @@ -17,15 +17,22 @@ for (qw[lei(1) lei-convert(1) lei-daemon-kill(1) lei-daemon-pid(1) + lei-edit-search(1) lei-forget-external(1) + lei-forget-search(1) lei-import(1) lei-init(1) + lei-lcat(1) lei-ls-external(1) lei-ls-label(1) + lei-ls-mail-sync(1) + lei-ls-search(1) lei-overview(7) lei-p2q(1) lei-q(1) + lei-rediff(1) lei-tag(1) + lei-up(1) public-inbox.cgi(1) public-inbox-compact(1) public-inbox-config(5) @@ -68,6 +75,7 @@ for (qw[git(1) git-config(1) git-credential(1) git-daemon(1) + git-diff(1) git-fast-import(1) git-fetch(1) git-filter-branch(1) diff --git a/MANIFEST b/MANIFEST index 29e62880..c7084671 100644 --- a/MANIFEST +++ b/MANIFEST @@ -23,21 +23,28 @@ Documentation/hosted.txt Documentation/include.mk Documentation/lei-add-external.pod Documentation/lei-blob.pod +Documentation/lei-cat.pod Documentation/lei-config.pod Documentation/lei-convert.pod Documentation/lei-daemon-kill.pod Documentation/lei-daemon-pid.pod +Documentation/lei-edit-search.pod Documentation/lei-forget-external.pod +Documentation/lei-forget-search.pod Documentation/lei-import.pod Documentation/lei-init.pod Documentation/lei-ls-external.pod Documentation/lei-ls-label.pod +Documentation/lei-ls-mail-sync.pod +Documentation/lei-ls-search.pod Documentation/lei-mail-formats.pod Documentation/lei-overview.pod Documentation/lei-p2q.pod Documentation/lei-q.pod +Documentation/lei-rediff.pod Documentation/lei-store-format.pod Documentation/lei-tag.pod +Documentation/lei-up.pod Documentation/lei.pod Documentation/lei_design_notes.txt Documentation/marketing.txt diff --git a/Makefile.PL b/Makefile.PL index d149a164..2af8c2f1 100644 --- a/Makefile.PL +++ b/Makefile.PL @@ -45,9 +45,11 @@ $v->{-m1} = [ map { } } @EXE_FILES, qw( - lei-add-external lei-blob lei-config lei-convert lei-daemon-kill - lei-daemon-pid lei-forget-external lei-import lei-init lei-ls-external - lei-ls-label lei-p2q lei-q lei-tag)]; + lei-add-external lei-blob lei-config lei-convert lei-edit-search + lei-daemon-kill lei-daemon-pid lei-forget-external lei-forget-search + lei-import lei-init lei-lcat lei-ls-external lei-ls-label + lei-ls-mail-sync lei-ls-search lei-p2q lei-q lei-rediff lei-tag + lei-up)]; $v->{-m5} = [ qw(public-inbox-config public-inbox-v1-format public-inbox-v2-format public-inbox-extindex-format lei-mail-formats lei-store-format -- 2.31.1