summaryrefslogtreecommitdiff
path: root/nginx-confgen.pod
diff options
context:
space:
mode:
authorYorhel <git@yorhel.nl>2018-01-24 13:25:27 +0100
committerYorhel <git@yorhel.nl>2018-01-24 13:25:27 +0100
commit005acbf1d2bdb56d358d1e4e3a74f498a6e9cbdc (patch)
tree3ea30f8567f8eae5bbcd23607ed0bd077efd813f /nginx-confgen.pod
parent45c5ed1ded1c68d610597da8bffe2b19a00dddeb (diff)
Add some commandline options
Diffstat (limited to 'nginx-confgen.pod')
-rw-r--r--nginx-confgen.pod28
1 files changed, 27 insertions, 1 deletions
diff --git a/nginx-confgen.pod b/nginx-confgen.pod
index 10af518..2bc0176 100644
--- a/nginx-confgen.pod
+++ b/nginx-confgen.pod
@@ -7,7 +7,7 @@ files.
=head1 SYNOPSIS
-nginx-confgen <input.conf >output.conf
+nginx-confgen -i input.conf -o output.conf
=head1 DESCRIPTION
@@ -30,6 +30,32 @@ below.
B<WARNING:> Do NOT use nginx-confgen with untrusted input, the C<pre_exec>
directive allows, by design, arbitrary code execution.
+=head1 OPTIONS
+
+The following command-line options are supported:
+
+=over
+
+=item -h
+
+Show help text.
+
+=item -V, --version
+
+Show program version.
+
+=item -i I<FILE>
+
+Use the given file name as input file. If this option is not given or set to
+C<->, then the file will be read from standard input.
+
+=item -o I<FILE>
+
+Write the output to the given file. If this option is not given or set to C<->,
+then the file will be written to standard output.
+
+=back
+
=head1 DIRECTIVES