From: Willy Tarreau <w@1wt.eu>
Date: Mon, 8 Nov 2021 07:37:40 +0000 (+0100)
Subject: CLEANUP: halog: make the default usage message fit in small screens
X-Git-Tag: v2.5-dev14~44
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=87e7eafde4022f9f6947a52a0d8dc1f846b7cfd5;p=thirdparty%2Fhaproxy.git

CLEANUP: halog: make the default usage message fit in small screens

The usage message was starting to have long lines, it's preferable that
it still fits well into a default 80-col display so that options are
easy to find. Also cut that into the 3 parts (input filter, modifier,
output format) for improved legibility.
---

diff --git a/admin/halog/halog.c b/admin/halog/halog.c
index f368c1c6f4..c7697dc524 100644
--- a/admin/halog/halog.c
+++ b/admin/halog/halog.c
@@ -147,13 +147,14 @@ void usage(FILE *output, const char *msg)
 {
 	fprintf(output,
 		"%s"
-		"Usage: halog [-h|--help] for long help\n"
-		"       halog [-q] [-c] [-m <lines>]\n"
-		"       {-cc|-gt|-pct|-st|-tc|-srv|-u|-uc|-ue|-ua|-ut|-uao|-uto|-uba|-ubt|-ic\n"
-		"           |-hdr <block>:<field>\n"
-		"       }\n"
-		"       [-s <skip>] [-e|-E] [-H] [-rt|-RT <time>] [-ad <delay>] [-ac <count>] [-query]\n"
-		"       [-v] [-Q|-QS] [-tcn|-TCN <termcode>] [ -hs|-HS [min][:[max]] ] [ -time [min][:[max]] <log\n"
+		"Usage:\n"
+		"  halog [-h|--help] for long help\n"
+		"  halog [input_filters]* [modifiers]* [output_format] < log\n"
+		"    inp = [-e|-E] [-H] [-Q|-QS] [-rt|-RT <time>] [-ad <delay>] [-ac <count>]\n"
+		"          [-hs|-HS [min][:[max]]] [-tcn|-TCN <termcode>] [-time [min][:[max]]]\n"
+		"    mod = [-q] [-v] [-m <lines>] [-s <skipflds>] [-query]\n"
+		"    out = {-c|-u|-uc|-ue|-ua|-ut|-uao|-uto|-uba|-ubt|-hdr <block>:<field>|\n"
+		"           -cc|-gt|-pct|-st|-tc|-srv|-ic}\n"
 		"\n",
 		msg ? msg : ""
 		);
@@ -169,7 +170,7 @@ void help()
 {
 	usage(stdout, NULL);
 	printf(
-	       "Input filters (several filters may be combined) :\n"
+	       "Input filters - several filters may be combined\n"
 	       " -H                      only match lines containing HTTP logs (ignore TCP)\n"
 	       " -E                      only match lines without any error (no 5xx status)\n"
 	       " -e                      only match lines with errors (status 5xx or negative)\n"
@@ -189,7 +190,7 @@ void help()
 	       "                         you can also use -n to start from earlier then field %d\n"
 	       " -query                  preserve the query string for per-URL (-u*) statistics\n"
 	       "\n"
-	       "Output filters - only one may be used at a time\n"
+	       "Output format - only one may be used at a time\n"
 	       " -c    only report the number of lines that would have been printed\n"
 	       " -pct  output connect and response times percentiles\n"
 	       " -st   output number of requests per HTTP status code\n"