]> Sergey Matveev's repositories - public-inbox.git/blobdiff - Documentation/lei.pod
doc lei overview: better explain routes into local store
[public-inbox.git] / Documentation / lei.pod
index 9ce9e9a4dc6cde8149cfbef5bcf530325958c59e..6c8cfc3d23e6cda4702a289415b11d5c34c152b1 100644 (file)
@@ -4,7 +4,7 @@ lei - local email interface for public-inbox
 
 =head1 SYNOPSIS
 
-lei COMMAND
+lei [OPTIONS] COMMAND
 
 =head1 DESCRIPTION
 
@@ -19,6 +19,23 @@ indices).
 
 Available in public-inbox 1.7.0+.
 
+=head1 OPTIONS
+
+=over
+
+=item -c NAME=VALUE
+
+Override configuration C<NAME> to C<VALUE>.
+
+=item -C DIR
+
+Change current working directory to the specified directory before
+running the command.  This option can be given before or after
+C<COMMAND> and is accepted by all lei subcommands except
+L<lei-daemon-kill(1)>.
+
+=back
+
 =head1 COMMANDS
 
 Subcommands for initializing and managing local, writable storage:
@@ -29,6 +46,8 @@ Subcommands for initializing and managing local, writable storage:
 
 =item * L<lei-import(1)>
 
+=item * L<lei-mark(1)>
+
 =back
 
 The following subcommands can be used to manage and inspect external
@@ -49,12 +68,14 @@ store and configured externals are
 
 =over
 
+=item * L<lei-blob(1)>
+
+=item * L<lei-p2q(1)>
+
 =item * L<lei-q(1)>
 
 =back
 
-TODO: Add lei-show (and perhaps others) once implemented.
-
 Other subcommands include
 
 =over
@@ -65,6 +86,8 @@ Other subcommands include
 
 =item * L<lei-daemon-pid(1)>
 
+=item * L<lei-ls-label(1)>
+
 =back
 
 =head1 FILES