commit 760855c5654538a5eeef7d8adf062cf65a5f50ea
parent 75a8f04cd07592a5e35e1c2fa3b4eef97c18dd18
Author: Quentin Rameau <quinq@fifth.space>
Date: Tue, 10 Nov 2015 16:35:26 +0100
Simplify argument names in usage() and manual
Diffstat:
addrom.1 | | | 79 | +++++++++++++++++++++++++++++++++++++++++++++---------------------------------- |
addrom.c | | | 5 | +++-- |
2 files changed, 48 insertions(+), 36 deletions(-)
diff --git a/addrom.1 b/addrom.1
@@ -6,56 +6,67 @@
.Sh SYNOPSIS
.Bk -words
.Nm
-.Op Fl c Ar Chinese-name
-.Op Fl e Ar English-name
-.Fl i Ar input-list
+.Op Fl c Ar title
+.Op Fl e Ar title
+.Fl i Ar file
.Op Fl n Ar position
-.Op Fl o Ar output-list
-.Fl r Ar rom-name
+.Op Fl o Ar file
+.Fl r Ar name
.Nm
-.Op Fl c Ar Chinese-name
-.Op Fl e Ar English-name
-.Op Fl i Ar input-list
+.Op Fl c Ar title
+.Op Fl e Ar title
+.Op Fl i Ar file
.Op Fl n Ar position
-.Fl o Ar output-list
-.Fl r Ar rom-name
+.Fl o Ar file
+.Fl r Ar name
.Ek
.Sh DESCRIPTION
.Nm
-reads a PB3 game list from an
-.Ar input-list
-file or starts one from scratch, adds an entry composed of a
-.Ar Chinese-name
-an
-.Ar English-name
-and a
-.Ar rom-name
+reads a PB3 game list from an input
+.Ar file
+or starts one from scratch, adds an entry composed of a Chinese
+.Ar title
+an English
+.Ar title
+and a rom
+.Ar name
at the given
.Ar position ,
-and writes the resulting list to the
-.Ar output-list
-file or the
-.Ar input-list
-file. It automatically adapts the number of game entries in this file.
+and writes the resulting list to the output
+.Ar file
+or the input
+.Ar file .
+.br
+It automatically adapts the number of game entries in this
+.Ar file .
.Sh OPTIONS
.Bl -tag -width Ds
.Bk -words
-.It Fl c Ar Chinese-name
-The Chinese name of the game displayed on the arcade.
-.It Fl e Ar English-name
-The English name of the game displayed on the arcade.
-.It Fl i Ar input-list
-Read list from input list.dat file and optionally write to it.
+.It Fl c Ar title
+The Chinese
+.Ar title
+of the game displayed on the arcade.
+.It Fl e Ar title
+The English
+.Ar title
+of the game displayed on the arcade.
+.It Fl i Ar file
+Read list from input list.dat
+.Ar file
+and optionally write to it.
.It Fl n Ar position
Placement of the new entry starting from 1. If the
.Ar position
is not given or is larger than number of games in the list, the new entry will
be appended to the end of the list.
-.It Fl o Ar output-list
-Write new list to output list.dat file (it must not exist and will not be
-overwritten).
-.It Fl r Ar rom-name
-The name of the rom file, without file extention (ie. "wjammers").
+.It Fl o Ar file
+Write new list to output list.dat
+.Ar file
+(it must not exist and will not be overwritten).
+.It Fl r Ar name
+The
+.Ar name
+of the rom file, without file extention (ie. "wjammers").
.Ek
.El
.Sh CAVEATS
diff --git a/addrom.c b/addrom.c
@@ -96,8 +96,9 @@ ecalloc(const ssize_t size)
static void
usage(void)
{
- die("usage: %s [-c chinesetitle] [-e englishtitle] -i inputlist "
- "[-n placeinlist] -o outputlist -r romname\n", basename(argv0));
+ die("usage: %s [-c title] [-e title] [-i file] [-n position] -o file -r name\n"
+ " %s [-c title] [-e title] -i file [-n position] [-o file] -r name\n",
+ basename(argv0), basename(argv0));
}
int