doc: document the "--" option

Closes #104
MusicPlayerDaemon · Dec 21, 2023 · 687df7a · 687df7a
1 parent 834502e
commit 687df7a
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/doc/index.rst b/doc/index.rst
@@ -14,7 +14,10 @@ given, the current status is printed (same as ":samp:`mpc status`").
 Synopsis
 --------
 
- mpc [options] <command> [<arguments>]
+ mpc [options] <command> [--] [<arguments>]
+
+After ``--``, all parameters are considered to be arguments, not
+options, even if they start with a dash.
 
 
 Options

diff --git a/src/main.c b/src/main.c
@@ -152,7 +152,7 @@ static const struct command {
 static void
 print_usage(FILE *outfp, const char *progname)
 {
-	fprintf(outfp,"Usage: %s [options] <command> [<arguments>]\n"
+	fprintf(outfp,"Usage: %s [options] <command> [--] [<arguments>]\n"
 		"mpc version: "VERSION"\n",progname);
 }