diff options
author | Bryan Newbold <bnewbold@archive.org> | 2020-08-25 19:25:40 -0700 |
---|---|---|
committer | Bryan Newbold <bnewbold@archive.org> | 2020-08-25 19:25:40 -0700 |
commit | a1f827a8c7457b0d28f77906e2f4051fb051bb71 (patch) | |
tree | 43a813114ed51ecc0a6e39f75887be0092b51b2a /es-public-proxy.1.scdoc | |
parent | f77729e13a26dac9d1085cf07a1eb182b1a815e0 (diff) | |
download | es-public-proxy-a1f827a8c7457b0d28f77906e2f4051fb051bb71.tar.gz es-public-proxy-a1f827a8c7457b0d28f77906e2f4051fb051bb71.zip |
add start of a manpage, using scdoc
Diffstat (limited to 'es-public-proxy.1.scdoc')
-rw-r--r-- | es-public-proxy.1.scdoc | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/es-public-proxy.1.scdoc b/es-public-proxy.1.scdoc new file mode 100644 index 0000000..00104d9 --- /dev/null +++ b/es-public-proxy.1.scdoc @@ -0,0 +1,36 @@ +es-public-proxy(1) "es-public-proxy Manual Page" + +# NAME + +es-public-proxy - something something + +# SYNOPSIS + +es-public-proxy --config CONFIGFILE + +# DESCRIPTION + +# OPTIONS + +Argument processing is crude; only one option can be specified at a time. + +*-h, --help* + Prints help information + +*-V, --version* + Prints version information + +*--config <file>* [env: ES_PUBLIC_PROXY_CONFIG_PATH] + Supply path to configuration file (TOML), which is effectively required for operation + +*--example-config* + An annotated config file (TOML) will be printed to standard out. + +# EXAMPLES + +Some examples of usage will go here. + + es-public-proxy --example-config > /etc/es_public_proxy.toml + + es-public-proxy --config /etc/es_public_proxy.toml + |