From e3dd5c16289892f216ab14ed5217bd261a4c1717 Mon Sep 17 00:00:00 2001 From: Kyle Meyer Date: Sun, 16 May 2021 23:35:27 -0400 Subject: doc lei: add manpages for new commands [ew: MANIFEST: s/lei-cat/lei-lcat/] --- 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 ++++ 11 files changed, 419 insertions(+), 1 deletion(-) 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 (limited to 'Documentation') 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) -- cgit v1.2.3-24-ge0c7