[docs] start a CLI options page

pull/692/head
Timothy Stack 5 years ago
parent 165cd69c8d
commit cd3b9bbb71

@ -0,0 +1,24 @@
.. _cli:
Command Line Interface
======================
-h Print these command-line options and exit.
-H Start lnav and switch to the help view.
-C Check the configuration for any errors and exit.
-c Execute the given command. This option can be given multiple times.
-f Execute the given command file. This option can be given multiple times.
-I path Add a configuration directory.
-i Install the format files in the ``.lnav/formats/`` directory.
Individual files will be installed in the ``installed``
directory and git repositories will be cloned with a directory
name based on their repository URI.
-u Update formats installed from git repositories.
-d file Write debug messages to the given file.
-n Run without the curses UI (headless mode).
-r Recursively load files from the given base directories.
-t Prepend timestamps to the lines of data being read in on the standard
input.
-w path Write the contents of the standard input to this file.
-V Print the version of lnav

@ -33,7 +33,10 @@ format2csv.main(["",
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.coverage']
extensions = [
'sphinx.ext.coverage',
"sphinx_rtd_theme",
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@ -99,12 +102,13 @@ pygments_style = 'sphinx'
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'nature'
html_theme = 'sphinx_rtd_theme'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
html_theme_options = {
}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []

@ -16,6 +16,7 @@ Contents:
intro
ui
cli
formats
data
sessions

@ -458,7 +458,7 @@ string execute_file(exec_context &ec, const string &path_and_args, bool multilin
retval = ec.get_error_prefix() + "no script specified";
}
else {
ec.ec_local_vars.push(map<string, string>());
ec.ec_local_vars.push({});
auto script_name = split_args[0];
map<string, string> &vars = ec.ec_local_vars.top();

Loading…
Cancel
Save