Documentation/lei-config.pod

   1 =head1 NAME
   2
   3 lei-config - git-config wrapper for lei configuration file
   4
   5 =head1 SYNOPSIS
   6
   7 lei config [OPTIONS]
   8
   9 =head1 DESCRIPTION
  10
  11 Call L<git-config(1)> with C<$XDG_CONFIG_HOME/lei/config> as the
  12 configuration file.  All C<OPTIONS> are passed through, but those that
  13 override the configuration file are not permitted.
  14
  15 All C<imap> and C<nntp> options may be specified per-host or
  16 (if using git 2.26+) with wildcards:
  17
  18         [imap "imap://*.onion"]
  19                 proxy = socks5h://127.0.0.1:9050
  20
  21         [nntp "nntp://example.com"]
  22                 proxy = socks5h://127.0.0.1:1080
  23
  24 =head2 VARIABLES
  25
  26 =over 8
  27
  28 =item external.*
  29
  30 Managed by L<lei-add-external(1)> and L<lei-forget-external(1)>
  31
  32 =item imap.proxy
  33
  34 =item nntp.proxy
  35
  36 The C<socks5h://> proxy address.  Older versions of SOCKS may
  37 be supported if there is user demand.
  38
  39 =item imap.starttls
  40
  41 =item nntp.starttls
  42
  43 Enable or disable STARTTLS on non-imaps:// and non-nntps://
  44 hosts.  By default, STARTTLS is enabled if available unless
  45 connecting to a Tor .onion or localhost.
  46
  47 =item imap.compress
  48
  49 =item nntp.compress
  50
  51 Enable protocol-level compression.  This may be incompatible
  52 or broken with some servers.
  53
  54 Note: L<Net::NNTP> compression support is pending:
  55 L<https://rt.cpan.org/Ticket/Display.html?id=129967>
  56
  57 =item imap.debug
  58
  59 =item nntp.debug
  60
  61 Enable debugging output of underlying IMAP and NNTP libraries,
  62 currently L<Mail::IMAPClient> and L<Net::NNTP>, respectively.
  63 If using L<imap.proxy> or L<nntp.proxy> point to a SOCKS proxy,
  64 debugging output for L<IO::Socket::Socks> will be enabled, as
  65 well.
  66
  67 Disabling L<imap.compress> may be required for readability.
  68
  69 =item imap.timeout
  70
  71 =item nntp.timeout
  72
  73 The read timeout for responses.
  74
  75 Default: 600 seconds (IMAP); 120 seconds (NNTP)
  76
  77 =item imap.fetchBatchSize
  78
  79 Number of full messages to fetch at once.  Larger values reduce
  80 network round trips at the cost of higher memory use, especially
  81 when retrieving large messages.
  82
  83 Small responses for IMAP flags are fetched at 10000 times this value.
  84
  85 Default: 1
  86
  87 =item color.SLOT
  88
  89 C<quoted>, C<hdrdefault>, C<status>, C<attachment> color slots
  90 are supported for the C<-f text> and C<-f reply> output formats
  91 of L<lei-lcat(1)> and L<lei-q(1)>.
  92
  93 Any per-project .git/config, and global ~/.gitconfig files
  94 will also be parsed for diff coloring.  git diff color slots
  95 (C<color.diff.SLOT>) supported are C<new>, C<old>, C<meta>,
  96 C<frag>, C<func>, and C<context>.
  97
  98 =back
  99
 100 =head1 CONTACT
 101
 102 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
 103
 104 The mail archives are hosted at L<https://public-inbox.org/meta/> and
 105 L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
 106
 107 =head1 COPYRIGHT
 108
 109 Copyright 2021 all contributors L<mailto:meta@public-inbox.org>
 110
 111 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>