user/dev discussion of public-inbox itself
 help / color / mirror / code / Atom feed
blob c91f36eed4ed9de6477e8293282737bf1ff5dc9f 2875 bytes (raw)
name: Documentation/lei-config.pod 	 # note: path name is non-authoritative(*)

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
=head1 NAME

lei-config - git-config wrapper for lei configuration file

=head1 SYNOPSIS

lei config [OPTIONS]

=head1 DESCRIPTION

Call L<git-config(1)> with C<$XDG_CONFIG_HOME/lei/config> as the
configuration file.  All C<OPTIONS> are passed through, but those that
override the configuration file are not permitted.

All C<imap> and C<nntp> 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<lei-add-external(1)> and L<lei-forget-external(1)>

=item imap.proxy

=item nntp.proxy

The C<socks5h://> 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<Net::NNTP> compression support is pending:
L<https://rt.cpan.org/Ticket/Display.html?id=129967>

=item imap.debug

=item nntp.debug

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
well.

Disabling L<imap.compress> may be required for readability.

=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<quoted>, C<hdrdefault>, C<status>, C<attachment> color slots
are supported for the C<-f text> and C<-f reply> output formats
of L<lei-lcat(1)> and L<lei-q(1)>.

Any per-project .git/config, and global ~/.gitconfig files
will also be parsed for diff coloring.  git diff color slots
(C<color.diff.SLOT>) supported are C<new>, C<old>, C<meta>,
C<frag>, C<func>, and C<context>.

=head1 CONTACT

Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>

The mail archives are hosted at L<https://public-inbox.org/meta/> and
L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>

=head1 COPYRIGHT

Copyright 2021 all contributors L<mailto:meta@public-inbox.org>

License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>

debug log:

solving c91f36ee ...
found c91f36ee in https://80x24.org/public-inbox.git

(*) Git path names are given by the tree(s) the blob belongs to.
    Blobs themselves have no identifier aside from the hash of its contents.^

Code repositories for project(s) associated with this public inbox

	https://80x24.org/public-inbox.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).