Doc fixes
authorEric Biggers <ebiggers3@gmail.com>
Thu, 23 May 2013 16:28:18 +0000 (11:28 -0500)
committerEric Biggers <ebiggers3@gmail.com>
Thu, 23 May 2013 16:28:18 +0000 (11:28 -0500)
doc/imagex-dir.1.in
include/wimlib.h

index 3f2409d..df59885 100644 (file)
@@ -2,7 +2,7 @@
 .SH NAME
 @IMAGEX_PROGNAME@-dir \- Show the files contained in a WIM archive
 .SH SYNOPSIS
-\fB@IMAGEX_PROGNAME@ dir\fR \fIWIMFILE\fR \fIIMAGE\fR
+\fB@IMAGEX_PROGNAME@ dir\fR \fIWIMFILE\fR \fIIMAGE\fR [\fIOPTIONS\fR]
 .SH DESCRIPTION
 Lists all the files and directories contained in the specified image of the
 Windows Imaging (WIM) file \fIWIMFILE\fR.
@@ -12,6 +12,11 @@ index of an image in the WIM, the name of an image in the WIM, or the keyword
 "all" to indicate that files from all images are to be shown.  Use the
 \fB@IMAGEX_PROGNAME@ info\fR (1) command to show what images a WIM file
 contains.
+.SH OPTIONS
+.TP 6
+\fB--path\fR=\fIPATH\fR
+List the files recursively from the \fIPATH\fR directory instead of from the
+root directory.
 .SH NOTES
 \fB@IMAGEX_PROGNAME@ dir\fR supports split WIMs, but it will only work on the
 first part of the split WIM.
index 783182f..087868a 100644 (file)
@@ -837,7 +837,7 @@ struct wimlib_dir_entry {
        uint32_t num_named_streams;
 
        /** Roughly, the inode number of this file.  However, it may be 0 if
-        * num_links == 1.  */
+        * @a num_links == 1.  */
        uint64_t hard_link_group_id;
 
        /** Time this file was created.  */
@@ -852,9 +852,10 @@ struct wimlib_dir_entry {
 
        /** Array of streams that make up this file.  The first entry will
         * always exist and will correspond to the unnamed data stream (default
-        * file contents), so it will have stream_name == NULL.  There will then
-        * be num_named_streams additional entries that specify the named data
-        * streams, if any, each of which will have stream_name != NULL.  */
+        * file contents), so it will have @a stream_name == @c NULL.  There
+        * will then be @a num_named_streams additional entries that specify the
+        * named data streams, if any, each of which will have @a stream_name !=
+        * @c NULL.  */
        struct wimlib_stream_entry streams[];
 };