Document that multiple enc control files are valid

Modify man pages and --help output for shcodecs-enc, shcodecs-record to show that multiple control files can be given on the commandline.
kfish · Mar 23, 2010 · 312066c · 312066c
1 parent a1242d5
commit 312066c
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 11 deletions.
diff --git a/doc/shcodecs-enc.1 b/doc/shcodecs-enc.1
@@ -5,7 +5,7 @@ shcodecs-enc \- Encode a video file using the SH-Mobile VPU
 
 .SH SYNOPSIS
 
-.B \fBshcodecs-enc\fR \fIcontrol-file\fR
+.B \fBshcodecs-enc\fR \fIcontrol-file\fR \fB...\fR
 .PP
 \fBshcodecs-enc\fR [\-h | \-\-help ]  [\-v  | \-\-version ]
 
@@ -21,7 +21,8 @@ Output version information and exit.
 
 .SH DESCRIPTION
 .B shcodecs-enc
-Encode an input file using the SH-Mobile VPU
+Encode according to the specifications of the given input file(s),
+using the SH-Mobile VPU
 
 .SH AUTHORS
 

diff --git a/doc/shcodecs-record.1 b/doc/shcodecs-record.1
@@ -5,20 +5,16 @@ shcodecs-record \- Encode V4L2 video input using the SH-Mobile VPU
 
 .SH SYNOPSIS
 .PP
-.B \fBshcodecs-record\fR \fIcontrol-file\fR
+.B \fBshcodecs-record\fR \fIcontrol-file\fR \fB...\fR
 .PP
-.B \fBshcodecs-record\fR [\-r \fB90\fR | \-\-rotate \fB90\fR ] \fBcontrol-file\fR
+.B \fBshcodecs-record\fR [\-r \fB90\fR | \-\-rotate \fB90\fR ] \fBcontrol-file\fR \fB...\fR
 .PP
 \fBshcodecs-record\fR [\-h  | \-\-help ]  [\-v  | \-\-version ]
 
 .SH OPTIONS
 .PP
 \fBshcodecs-record\fR accepts the following options:
 
-.SS "File options"
-.IP "\fBcontrol-file\fR" 10
-Set the control file.
-
 .SS "Capture options"
 .IP "\-r \fB90\fR, \-\-rotate \fB90\fR" 10
 Rotate and crop the image 90 degrees before encoding.
@@ -31,7 +27,8 @@ Output version information and exit.
 
 .SH DESCRIPTION
 .B shcodecs-record
-Encodes V4L2 video input as an H.264 or MPEG-4 Elementary Stream using the SH-Mobile VPU.
+Encodes V4L2 video input as an H.264 or MPEG-4 Elementary Stream using the SH-Mobile VPU,
+according to the specifications of the given input file(s).
 
 .SH AUTHORS
 

diff --git a/src/tools/shcodecs-enc.c b/src/tools/shcodecs-enc.c
@@ -42,7 +42,7 @@
 static void
 usage (const char * progname)
 {
-	printf ("Usage: %s <control file>\n", progname);
+	printf ("Usage: %s <control file> ...\n", progname);
 	printf ("Encode a video file using the SH-Mobile VPU\n");
 	printf ("\nMiscellaneous options\n");
 	printf ("  -h, --help             Display this help and exit\n");

diff --git a/src/tools/shcodecs-record.c b/src/tools/shcodecs-record.c
@@ -118,7 +118,7 @@ static struct option long_options[] = {
 static void
 usage (const char * progname)
 {
-  printf ("Usage: %s [options] <control file>\n", progname);
+  printf ("Usage: %s [options] <control file> ...\n", progname);
   printf ("Encode video from a V4L2 device using the SH-Mobile VPU, with preview\n");
   printf ("\nCapture options\n");
   printf ("  -r 90, --rotate 90   Rotate the camera capture buffer 90 degrees and crop\n");