Add --help option

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
Part-of: <https://gitlab.freedesktop.org/xorg/test/rendercheck/-/merge_requests/4>

2 files changed, 20 insertions, 8 deletions

diff --git a/main.c b/main.c
index c18c2d1..b63d22e 100644
--- a/main.c
+++ b/main.c
@@ -148,14 +148,14 @@ void print_tests(FILE *file, int tests) {
 
 _X_NORETURN
 static void
-usage (char *program)
+usage (const char *program, int exitcode)
 {
     fprintf(stderr, "usage: %s [-d|--display display] [-v|--verbose]\n"
 	"\t[-t test1,test2,...] [-o op1,op2,...] [-f format1,format2,...]\n"
-	"\t[--sync] [--minimalrendering] [--version]\n"
+	"\t[--sync] [--minimalrendering] [--help] [--version]\n"
 	"Available tests:\n", program);
     print_tests(stderr, ~0);
-    exit(1);
+    exit(exitcode);
 }
 
 int main(int argc, char **argv)
@@ -178,6 +178,7 @@ int main(int argc, char **argv)
 		{ "tests",	required_argument,	NULL,	't' },
 		{ "ops",	required_argument,	NULL,	'o' },
 		{ "verbose",	no_argument,		NULL,	'v' },
+		{ "help",	no_argument,		NULL,	'?' },
 		{ "sync",	no_argument,		&is_sync, true},
 		{ "minimalrendering", no_argument,
 		  &longopt_minimalrendering, true},
@@ -185,7 +186,7 @@ int main(int argc, char **argv)
 		{ NULL,		0,			NULL,	0 }
 	};
 
-	while ((o = getopt_long(argc, argv, "d:i:f:t:o:v", longopts, NULL)) != -1) {
+	while ((o = getopt_long(argc, argv, "d:i:f:t:o:v?", longopts, NULL)) != -1) {
 		switch (o) {
 		case 'd':
 			display = optarg;
@@ -207,7 +208,7 @@ int main(int argc, char **argv)
 					break;
 				}
 				if (i == num_ops)
-					usage(argv[0]);
+					usage(argv[0], EXIT_FAILURE);
 			}
 			break;
 		case 'f':
@@ -258,17 +259,20 @@ int main(int argc, char **argv)
 					}
 				}
 				if (!found)
-					usage(argv[0]);
+					usage(argv[0], EXIT_FAILURE);
 			}
 
 			break;
 		case 'v':
 			is_verbose = true;
 			break;
+                case '?':
+			usage(argv[0], EXIT_SUCCESS);
+			break;
 		case 0:
 			break;
 		default:
-			usage(argv[0]);
+			usage(argv[0], EXIT_FAILURE);
 			break;
 		}
 	}
diff --git a/man/rendercheck.man b/man/rendercheck.man
index a4d4684..936e88c 100644
--- a/man/rendercheck.man
+++ b/man/rendercheck.man
@@ -1,5 +1,5 @@
 .ds q \N'34'
-.TH RENDERCHECK 1 2006-10-26 "rendercheck @version@" "X Version 11"
+.TH RENDERCHECK 1 2025-04-26 "rendercheck @version@" "X Version 11"
 .SH NAME
 rendercheck \- simple tests of the X Render extension.
 .SH SYNOPSIS
@@ -9,6 +9,8 @@ rendercheck \- simple tests of the X Render extension.
     [\fB\-t\fP|\fB\-\-tests\fP \fItest1\fP,\fItest2\fP,\fItest3\fP,...] \
 [\fB\-o\fP|\fB\-\-ops\fP \fIop1\fP,\fIop2\fP,\fIop3\fP,...]
     [\fB\-v|\fB\-\-verbose\fP] [\fB\-\-minimalrendering\fP]
+
+\fBrendercheck\fP [\fB\-\-help\fP|\fB\-\-version\fP]
 .fi
 .SH DESCRIPTION
 .B rendercheck
@@ -54,6 +56,12 @@ and successes and failures.
 .B \-\-minimalrendering
 Disables copying of offscreen destinations to the window,
 which is on by default to provide the user with visual feedback.
+.TP
+.B \-\-help
+Prints usage message and exits.
+.TP
+.B \-\-version
+Prints version information and exits.
 .SH BUGS
 Several limitations are documented in the TODO file accompanying the source.
 Please report any further bugs you find to