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: X-Spam-Status: No, score=-4.0 required=3.0 tests=ALL_TRUSTED,BAYES_00 shortcircuit=no autolearn=ham autolearn_force=no version=3.4.2 Received: from localhost (dcvr.yhbt.net [127.0.0.1]) by dcvr.yhbt.net (Postfix) with ESMTP id 4A8B01FC9F for ; Sun, 19 Sep 2021 12:50:37 +0000 (UTC) From: Eric Wong To: meta@public-inbox.org Subject: [PATCH 16/16] doc: lei-config: document various knobs Date: Sun, 19 Sep 2021 12:50:35 +0000 Message-Id: <20210919125035.6331-17-e@80x24.org> In-Reply-To: <20210919125035.6331-1-e@80x24.org> References: <20210919125035.6331-1-e@80x24.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit List-Id: It's still a work-in-progress, but the basic debug knob comes in handy for new users; as does proxy support. --- Documentation/lei-config.pod | 91 +++++++++++++++++++++++++++++++++++- 1 file changed, 90 insertions(+), 1 deletion(-) diff --git a/Documentation/lei-config.pod b/Documentation/lei-config.pod index a64045ef..daf66fe4 100644 --- a/Documentation/lei-config.pod +++ b/Documentation/lei-config.pod @@ -8,10 +8,99 @@ lei config [OPTIONS] =head1 DESCRIPTION -Call git-config(1) with C<$XDG_CONFIG_HOME/lei/config> as the +Call L with C<$XDG_CONFIG_HOME/lei/config> as the configuration file. All C are passed through, but those that override the configuration file are not permitted. +All C and C options may be specified per-host or +(if using git 2.26+) with wildcards: + + [imap "imap://*.onion"] + proxy = socks5h://127.0.0.1:9050 + + [nntp "nntp://example.com"] + proxy = socks5h://127.0.0.1:1080 + +=head2 VARIABLES + +=over 8 + +=item external.* + +Managed by L and L + +=item imap.proxy + +=item nntp.proxy + +The C proxy address. Older versions of SOCKS may +be supported if there is user demand. + +=item imap.starttls + +=item nntp.starttls + +Enable or disable STARTTLS on non-imaps:// and non-nntps:// +hosts. By default, STARTTLS is enabled if available unless +connecting to a Tor .onion or localhost. + +=item imap.compress + +=item nntp.compress + +Enable protocol-level compression, this may be incompatible +or broken with some servers. + +Note: L compression support is pending: +L + +=item imap.debug + +=item nntp.debug + +Enable debugging output of underlying IMAP and NNTP libraries, +currently L and L, respectively. +If using L or L point to a SOCKS proxy, +debugging output for L will be enabled, as +well. + +Disabling L may be required to improve output. + +=item imap.timeout + +=item nntp.timeout + +The read timeout for responses. + +Default: 600 seconds (IMAP); 120 seconds (NNTP) + +=item imap.fetchBatchSize + +Number of full messages to fetch at once. Larger values reduce +network round trips at the cost of higher memory use, especially +when retrieving large messages. + +Small responses for IMAP flags are fetched at 10000 times this value. + +Default: 1 + +=item imap.ignoreSizeErrors + +Ignore size mismatches from broken IMAP server implementations. + +Default: false + +=item color.SLOT + +C, C, C, C color slots +are supported for the C<-f text> and C<-f reply> output formats +of L and L. + +The any per-project .git/config, and global ~/.gitconfig files +will also be parsed for diff coloring. git diff color slots +(C) supported are C, C, C, +C, C, and C. + =head1 CONTACT Feedback welcome via plain-text mail to L