about summary refs log tree commit homepage
path: root/Documentation
diff options
context:
space:
mode:
authorŠtěpán Němec <stepnem@smrk.net>2023-10-16 13:33:02 +0200
committerEric Wong <e@80x24.org>2023-10-17 03:33:32 +0000
commit420f9b567e20290d2068715cd718f5092157543c (patch)
tree1ccee26ec5a30e594e0d22a6b0f2a1a9c534d1eb /Documentation
parent03caba7a0fec0cb44372045b72abf2debb376140 (diff)
downloadpublic-inbox-420f9b567e20290d2068715cd718f5092157543c.tar.gz
[ew: leave install/README unchanged pending wording changes]
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/RelNotes/v1.9.0.eml2
-rw-r--r--Documentation/RelNotes/v2.0.0.wip6
-rw-r--r--Documentation/lei-config.pod8
-rw-r--r--Documentation/lei-daemon-kill.pod2
-rw-r--r--Documentation/lei-inspect.pod4
-rw-r--r--Documentation/lei-lcat.pod2
-rw-r--r--Documentation/lei-ls-mail-source.pod2
-rw-r--r--Documentation/lei-ls-search.pod2
-rw-r--r--Documentation/lei-mail-sync-overview.pod2
-rw-r--r--Documentation/lei-q.pod4
-rw-r--r--Documentation/lei-security.pod8
-rw-r--r--Documentation/lei-store-format.pod2
-rw-r--r--Documentation/lei-up.pod4
13 files changed, 24 insertions, 24 deletions
diff --git a/Documentation/RelNotes/v1.9.0.eml b/Documentation/RelNotes/v1.9.0.eml
index 2d83cbfe..08e16a66 100644
--- a/Documentation/RelNotes/v1.9.0.eml
+++ b/Documentation/RelNotes/v1.9.0.eml
@@ -46,7 +46,7 @@ Search improvements:
   * patchid: prefix search support added to WWW and lei for
     "git patch-id --stable" support
 
-  * text inside base-85 binary patches are no longer indexed
+  * text inside base-85 binary patches is no longer indexed
     to avoid false positives
 
   * for lei users, "lei reindex" now exists and is required
diff --git a/Documentation/RelNotes/v2.0.0.wip b/Documentation/RelNotes/v2.0.0.wip
index 40c87169..859d858b 100644
--- a/Documentation/RelNotes/v2.0.0.wip
+++ b/Documentation/RelNotes/v2.0.0.wip
@@ -57,11 +57,11 @@ lei
 
   * compatibility with SQLite <3.8.3 on CentOS 7.x
 
-  * fix `lei q -tt' on locally-indexed messages (still broken for remotes:
+  * fix `lei q -tt' on locally indexed messages (still broken for remotes:
     https://public-inbox.org/meta/20230226170931.M947721@dcvr/ )
 
   * `lei import' now sets labels+keywords consistently on all
-     already-imported messages
+     already imported messages
 
 solver (used by lei (rediff|blob), and PublicInbox::WWW)
 
@@ -101,7 +101,7 @@ PublicInbox::SaPlugin::ListMirror
 
 Search improvements (lei and PublicInbox::WWW)
 
-  * quoted text inside base-85 binary patches are no longer indexed
+  * quoted text inside base-85 binary patches is no longer indexed
 
 Thanks to all the bug reporters and users who made this release
 possible.
diff --git a/Documentation/lei-config.pod b/Documentation/lei-config.pod
index 23a60c8a..699f45cb 100644
--- a/Documentation/lei-config.pod
+++ b/Documentation/lei-config.pod
@@ -64,8 +64,8 @@ L<https://rt.cpan.org/Ticket/Display.html?id=129967>
 
 Enable debugging output of underlying IMAP and NNTP libraries,
 currently L<Mail::IMAPClient> and L<Net::NNTP>, respectively.
-If using L<imap.proxy> or L<nntp.proxy> point to a SOCKS proxy,
-debugging output for L<IO::Socket::Socks> will be enabled, as
+If L<imap.proxy> or L<nntp.proxy> points to a SOCKS proxy,
+debugging output for L<IO::Socket::Socks> will be enabled as
 well.
 
 Disabling L<imap.compress> may be required for readability.
@@ -104,7 +104,7 @@ C<frag>, C<func>, and C<context>.
 =head1 OPTIONS
 
 Most L<git-config(1)> command-line switches are accepted by C<lei config>
-as-is.  The most-frequently-used options are expected to be:
+as is.  The most frequently used options are expected to be:
 
 =over 4
 
@@ -112,7 +112,7 @@ as-is.  The most-frequently-used options are expected to be:
 
 =item --edit
 
-Opens an editor to edit the lei config file
+Open an editor to edit the lei config file.
 
 =item -l
 
diff --git a/Documentation/lei-daemon-kill.pod b/Documentation/lei-daemon-kill.pod
index 48c237b8..97a81e23 100644
--- a/Documentation/lei-daemon-kill.pod
+++ b/Documentation/lei-daemon-kill.pod
@@ -31,7 +31,7 @@ remain running after a short while after this takes effect.
 =back
 
 =for comment
-SIGQUIT and SIGINT currently do what SIGTERM do, may change...
+SIGQUIT and SIGINT currently do what SIGTERM does, may change...
 
 =head1 CONTACT
 
diff --git a/Documentation/lei-inspect.pod b/Documentation/lei-inspect.pod
index 19dd8ab5..82b9651a 100644
--- a/Documentation/lei-inspect.pod
+++ b/Documentation/lei-inspect.pod
@@ -26,7 +26,7 @@ An inboxdir, extindex topdir, or Xapian shard
 
 =item --pretty
 
-Pretty print output.  If stdout is opened to a tty, C<--pretty> is
+Pretty-print output.  If stdout is opened to a tty, C<--pretty> is
 enabled by default.
 
 =item -
@@ -47,7 +47,7 @@ L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
 
 =head1 COPYRIGHT
 
-Copyright 2021 all contributors L<mailto:meta@public-inbox.org>
+Copyright all contributors L<mailto:meta@public-inbox.org>
 
 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
 
diff --git a/Documentation/lei-lcat.pod b/Documentation/lei-lcat.pod
index e8073862..530b755e 100644
--- a/Documentation/lei-lcat.pod
+++ b/Documentation/lei-lcat.pod
@@ -31,7 +31,7 @@ C<-f text> when writing to stdout.
 
 Most commonly C<text> (the default) or C<reply> to
 display the message(s) in a format suitable for trimming
-and sending as a email reply.
+and sending as an email reply.
 
 =item --stdin
 
diff --git a/Documentation/lei-ls-mail-source.pod b/Documentation/lei-ls-mail-source.pod
index 59d14afe..0e485923 100644
--- a/Documentation/lei-ls-mail-source.pod
+++ b/Documentation/lei-ls-mail-source.pod
@@ -28,7 +28,7 @@ Format output as JSON and include more information.
 
 =item --pretty
 
-Pretty print JSON output.  If stdout is opened to a tty, C<--pretty>
+Pretty-print JSON output.  If stdout is opened to a tty, C<--pretty>
 is enabled by default.
 
 =item --ascii
diff --git a/Documentation/lei-ls-search.pod b/Documentation/lei-ls-search.pod
index 0fe4b759..367f4ad6 100644
--- a/Documentation/lei-ls-search.pod
+++ b/Documentation/lei-ls-search.pod
@@ -26,7 +26,7 @@ C<jsonl>, or C<concatjson>.
 
 =item --pretty
 
-Pretty print C<json> or C<concatjson> output.  If stdout is opened to
+Pretty-print C<json> or C<concatjson> output.  If stdout is opened to
 a tty and used as the C<--output> destination, C<--pretty> is enabled
 by default.
 
diff --git a/Documentation/lei-mail-sync-overview.pod b/Documentation/lei-mail-sync-overview.pod
index e30674bb..7ae7e887 100644
--- a/Documentation/lei-mail-sync-overview.pod
+++ b/Documentation/lei-mail-sync-overview.pod
@@ -20,7 +20,7 @@ Future work will be done to improve it and add IMAP IDLE support.
   # dump "inbox" labeled files from the past week to a Maildir
   lei q L:inbox rt:last.week.. -o /tmp/results
 
-  # open /tmp/results in your favorite mail agent.  If inotify or kevent
+  # Open /tmp/results in your favorite mail agent.  If inotify or kevent
   # works, keyword changes (e.g. marking messages as `seen') are
   # synchronized automatically.
 
diff --git a/Documentation/lei-q.pod b/Documentation/lei-q.pod
index c0254ba0..5f533849 100644
--- a/Documentation/lei-q.pod
+++ b/Documentation/lei-q.pod
@@ -80,7 +80,7 @@ Disable color (for C<-f reply> and C<-f text>).
 
 =item --pretty
 
-Pretty print C<json> or C<concatjson> output.  If stdout is opened to
+Pretty-print C<json> or C<concatjson> output.  If stdout is opened to
 a tty and used as the C<--output> destination, C<--pretty> is enabled
 by default.
 
@@ -218,7 +218,7 @@ Default: fcntl,dotlock
 
 =item -n NUMBER
 
-Fuzzy limit the number of matches per-local external and lei/store.
+Fuzzy-limit the number of matches per local external and lei/store.
 Messages added by the L<--threads> switch do not count towards this
 limit, and there is no limit on remote externals.
 
diff --git a/Documentation/lei-security.pod b/Documentation/lei-security.pod
index 104bfb48..e54cae90 100644
--- a/Documentation/lei-security.pod
+++ b/Documentation/lei-security.pod
@@ -4,7 +4,7 @@ lei - security information
 
 =head1 SYNOPSIS
 
-L<lei(1)> is intended for use with both publicly-archived
+L<lei(1)> is intended for use with both publicly archived
 and "private" mail in personal mailboxes.  This document is
 intended to give an overview of security implications and
 lower^Wmanage user expectations.
@@ -66,7 +66,7 @@ other users on the local system.
 
 =head1 CORE DUMPS
 
-In case any process crashes, a core dumps may contain passwords or
+In case any process crashes, a core dump may contain passwords or
 contents of sensitive messages.  Please report these so they can be
 fixed (see L</CONTACT>).
 
@@ -74,7 +74,7 @@ fixed (see L</CONTACT>).
 
 lei currently uses the L<curl(1)> and L<git(1)> executables in
 C<$PATH> for HTTP and HTTPS network access.  Interactive
-authentication for HTTP and HTTPS is not-yet-supported since all
+authentication for HTTP and HTTPS is not yet supported since all
 currently supported HTTP/HTTPS sources are L<PublicInbox::WWW>
 instances.
 
@@ -83,7 +83,7 @@ L<Net::NNTP> (standard library) is used for NNTP and NNTPS.
 
 L<Mail::IMAPClient> and L<Net::NNTP> will use L<IO::Socket::SSL>
 for TLS if available.  In turn, L<IO::Socket::SSL> uses the
-widely-installed OpenSSL library.
+widely installed OpenSSL library.
 
 STARTTLS will be attempted if advertised by the server
 unless IMAPS or NNTPS are used.  C<-c imap.starttls=0>
diff --git a/Documentation/lei-store-format.pod b/Documentation/lei-store-format.pod
index 625c60f4..d4bb42d5 100644
--- a/Documentation/lei-store-format.pod
+++ b/Documentation/lei-store-format.pod
@@ -67,7 +67,7 @@ the "same" message.
 
 =head2 mail_sync.sqlite3
 
-This SQLite database maintained for bidirectional mapping of
+This SQLite database is maintained for bidirectional mapping of
 git blobs to IMAP UIDs, Maildir file names, and NNTP article numbers.
 
 It is also used for retrieving messages from Maildirs indexed by
diff --git a/Documentation/lei-up.pod b/Documentation/lei-up.pod
index 3b7c6f46..8c426942 100644
--- a/Documentation/lei-up.pod
+++ b/Documentation/lei-up.pod
@@ -32,8 +32,8 @@ delays or downtime.
 The time(s) of the last successful queries are the C<lastresult>
 values visible from L<lei-edit-search(1)>.
 
-Date formats understood by L<git-rev-parse(1)> may be used.
-e.g C<1.hour> or C<3.days>
+Date formats understood by L<git-rev-parse(1)> may be used,
+e.g., C<1.hour> or C<3.days>.
 
 Default: 2.days