Commit 92a4bde3 authored by Nils Goroll's avatar Nils Goroll Committed by Pål Hermunn Johansen

vut clients: consistently mark all <non-literal options>

In usage/documentation, mark those options with <> which are not a
literal string, but rather a placeholder for some value.

Conflicts:
	bin/varnishstat/varnishstat_options.h
parent 80a169e8
...@@ -43,7 +43,7 @@ ...@@ -43,7 +43,7 @@
) )
#define LOG_OPT_w \ #define LOG_OPT_w \
VOPT("w:", "[-w filename]", "Output filename", \ VOPT("w:", "[-w <filename>]", "Output filename", \
"Redirect output to file. The file will be overwritten" \ "Redirect output to file. The file will be overwritten" \
" unless the -a option was specified. If the application" \ " unless the -a option was specified. If the application" \
" receives a SIGHUP in daemon mode the file will be " \ " receives a SIGHUP in daemon mode the file will be " \
......
...@@ -36,12 +36,12 @@ ...@@ -36,12 +36,12 @@
) )
#define NCSA_OPT_F \ #define NCSA_OPT_F \
VOPT("F:", "[-F format]", "Set output format", \ VOPT("F:", "[-F <format>]", "Set output format", \
"Set the output log format string." \ "Set the output log format string." \
) )
#define NCSA_OPT_f \ #define NCSA_OPT_f \
VOPT("f:", "[-f formatfile]", "Read output format from file", \ VOPT("f:", "[-f <formatfile>]", "Read output format from file", \
"Read output format from a file. Will read a single line" \ "Read output format from a file. Will read a single line" \
" from the specified file, and use that line as the" \ " from the specified file, and use that line as the" \
" format." \ " format." \
...@@ -55,7 +55,7 @@ ...@@ -55,7 +55,7 @@
) )
#define NCSA_OPT_w \ #define NCSA_OPT_w \
VOPT("w:", "[-w filename]", "Output filename", \ VOPT("w:", "[-w <filename>]", "Output filename", \
"Redirect output to file. The file will be overwritten" \ "Redirect output to file. The file will be overwritten" \
" unless the -a option was specified. If the application" \ " unless the -a option was specified. If the application" \
" receives a SIGHUP in daemon mode the file will be" \ " receives a SIGHUP in daemon mode the file will be" \
......
...@@ -254,7 +254,7 @@ usage(void) ...@@ -254,7 +254,7 @@ usage(void)
"[-1lV] [-f field] [-t seconds|<off>] " "[-1lV] [-f field] [-t seconds|<off>] "
VSC_n_USAGE "\n"); VSC_n_USAGE "\n");
fprintf(stderr, FMT, "-1", "Print the statistics to stdout."); fprintf(stderr, FMT, "-1", "Print the statistics to stdout.");
fprintf(stderr, FMT, "-f field", "Field inclusion glob"); fprintf(stderr, FMT, "-f <glob>", "Field inclusion glob");
fprintf(stderr, FMT, "", fprintf(stderr, FMT, "",
"If it starts with '^' it is used as an exclusion list."); "If it starts with '^' it is used as an exclusion list.");
fprintf(stderr, FMT, "-l", fprintf(stderr, FMT, "-l",
......
...@@ -45,7 +45,7 @@ ...@@ -45,7 +45,7 @@
) )
#define TOP_OPT_p \ #define TOP_OPT_p \
VOPT("p:", "[-p period]", "Sampling period", \ VOPT("p:", "[-p <period>]", "Sampling period", \
"Specified the number of seconds to measure over, the" \ "Specified the number of seconds to measure over, the" \
" default is 60 seconds. The first number in the list is" \ " default is 60 seconds. The first number in the list is" \
" the average number of requests seen over this time" \ " the average number of requests seen over this time" \
......
...@@ -51,7 +51,7 @@ ...@@ -51,7 +51,7 @@
) )
#define VSL_OPT_i \ #define VSL_OPT_i \
VOPT("i:", "[-i taglist]", "Include tags", \ VOPT("i:", "[-i <taglist>]", "Include tags", \
"Include log records of these tags in output. Taglist is" \ "Include log records of these tags in output. Taglist is" \
" a comma-separated list of tag globs. Multiple -i" \ " a comma-separated list of tag globs. Multiple -i" \
" options may be given.\n" \ " options may be given.\n" \
...@@ -69,7 +69,7 @@ ...@@ -69,7 +69,7 @@
) )
#define VSL_OPT_L \ #define VSL_OPT_L \
VOPT("L:", "[-L limit]", "Incomplete transaction limit", \ VOPT("L:", "[-L <limit>]", "Incomplete transaction limit", \
"Sets the upper limit of incomplete transactions kept" \ "Sets the upper limit of incomplete transactions kept" \
" before the oldest transaction is force completed. A" \ " before the oldest transaction is force completed. A" \
" warning record is synthesized when this happens. This" \ " warning record is synthesized when this happens. This" \
...@@ -78,7 +78,7 @@ ...@@ -78,7 +78,7 @@
) )
#define VSL_OPT_T \ #define VSL_OPT_T \
VOPT("T:", "[-T seconds]", "Transaction end timeout", \ VOPT("T:", "[-T <seconds>]", "Transaction end timeout", \
"Sets the transaction timeout in seconds. This defines the" \ "Sets the transaction timeout in seconds. This defines the" \
" maximum number of seconds elapsed between a Begin tag" \ " maximum number of seconds elapsed between a Begin tag" \
" and the End tag. If the timeout expires, a warning" \ " and the End tag. If the timeout expires, a warning" \
...@@ -94,7 +94,7 @@ ...@@ -94,7 +94,7 @@
) )
#define VSL_OPT_x \ #define VSL_OPT_x \
VOPT("x:", "[-x taglist]", "Exclude tags", \ VOPT("x:", "[-x <taglist>]", "Exclude tags", \
"Exclude log records of these tags in output. Taglist is" \ "Exclude log records of these tags in output. Taglist is" \
" a comma-separated list of tag globs. Multiple -x" \ " a comma-separated list of tag globs. Multiple -x" \
" options may be given.\n" \ " options may be given.\n" \
......
...@@ -51,35 +51,35 @@ ...@@ -51,35 +51,35 @@
) )
#define VUT_OPT_k \ #define VUT_OPT_k \
VOPT("k:", "[-k num]", "Limit transactions", \ VOPT("k:", "[-k <num>]", "Limit transactions", \
"Process this number of matching log transactions before" \ "Process this number of matching log transactions before" \
" exiting." \ " exiting." \
) )
#define VUT_OPT_n \ #define VUT_OPT_n \
VOPT("n:", "[-n name]", "Varnish instance name", \ VOPT("n:", "[-n <name>]", "Varnish instance name", \
"Specify the name of the varnishd instance to get logs" \ "Specify the name of the varnishd instance to get logs" \
" from. If -n is not specified, the host name is used." \ " from. If -n is not specified, the host name is used." \
) )
#define VUT_OPT_N \ #define VUT_OPT_N \
VOPT("N:", "[-N filename]", "VSM filename", \ VOPT("N:", "[-N <filename>]", "VSM filename", \
"Specify the filename of a stale VSM instance. When using" \ "Specify the filename of a stale VSM instance. When using" \
" this option the abandonment checking is disabled." \ " this option the abandonment checking is disabled." \
) )
#define VUT_OPT_P \ #define VUT_OPT_P \
VOPT("P:", "[-P file]", "PID file", \ VOPT("P:", "[-P <file>]", "PID file", \
"Write the process' PID to the specified file." \ "Write the process' PID to the specified file." \
) )
#define VUT_OPT_q \ #define VUT_OPT_q \
VOPT("q:", "[-q query]", "VSL query", \ VOPT("q:", "[-q <query>]", "VSL query", \
"Specifies the VSL query to use." \ "Specifies the VSL query to use." \
) )
#define VUT_OPT_r \ #define VUT_OPT_r \
VOPT("r:", "[-r filename]", "Binary file input", \ VOPT("r:", "[-r <filename>]", "Binary file input", \
"Read log in binary file format from this file. The file" \ "Read log in binary file format from this file. The file" \
" can be created with ``varnishlog -w filename``." \ " can be created with ``varnishlog -w filename``." \
) )
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment