changeset 214:7fcff97ca5a9

document pst2dii font file arg not optional, patch from bharder to fix documentation for pst_getTopOfFolders
author Carl Byington <carl@five-ten-sg.com>
date Wed, 17 Jun 2009 22:11:12 -0700
parents 4a659f3138b7
children fef2214083a4
files src/libpst.h src/pst2dii.cpp.in xml/libpst.in
diffstat 3 files changed, 9 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
--- a/src/libpst.h	Mon Jun 08 14:47:39 2009 -0700
+++ b/src/libpst.h	Wed Jun 17 22:11:12 2009 -0700
@@ -933,7 +933,7 @@
 /** Get the top of folders descriptor tree. This is the main descriptor tree
  *  that needs to be walked to look at every item in the pst file.
  * @param pf   pointer to the pst_file structure setup by pst_open().
- * @param root root item, which can be obtained by pst_parse_item(pf, pf->d.head, NULL).
+ * @param root root item, which can be obtained by pst_parse_item(pf, pf->d_head, NULL).
  */
 pst_desc_tree*  pst_getTopOfFolders(pst_file *pf, const pst_item *root);
 
--- a/src/pst2dii.cpp.in	Mon Jun 08 14:47:39 2009 -0700
+++ b/src/pst2dii.cpp.in	Wed Jun 17 22:11:12 2009 -0700
@@ -98,7 +98,8 @@
 static void usage()
 {
     version();
-    printf("Usage: %s [OPTIONS] {PST FILENAME}\n", prog_name);
+    printf("Usage: %s -f ttf-font-file [OPTIONS] {PST FILENAME}\n", prog_name);
+    printf("\t-f ttf-font-file  \t- Set the font file\n");
     printf("OPTIONS:\n");
     printf("\t-B bates-prefix   \t- Set the bates prefix string\n");
     printf("\t-O dii-output-file\t- Set the dii load file output filename\n");
@@ -106,7 +107,6 @@
     printf("\t-b bates-number   \t- Set the starting bates sequence number\n");
     printf("\t-c bates-color    \t- Specify the color of the bates stamps as 6 digit hex\n");
     printf("\t-d filename       \t- Debug to file. This is a binary log. Use readpstlog to print it.\n");
-    printf("\t-f ttf-font-file  \t- Set the font file\n");
     printf("\t-h                \t- Help. This screen\n");
     printf("\t-o dirname        \t- Output directory to write files to.\n");
 }
@@ -678,6 +678,11 @@
         }
     }
 
+    if (!font_file) {
+        usage();
+        exit(1);
+    }
+
     if (argc > optind) {
         fname = argv[optind];
     } else {
--- a/xml/libpst.in	Mon Jun 08 14:47:39 2009 -0700
+++ b/xml/libpst.in	Wed Jun 17 22:11:12 2009 -0700
@@ -515,7 +515,7 @@
                 <arg><option>-b <replaceable class="parameter">bates-number</replaceable></option></arg>
                 <arg><option>-c <replaceable class="parameter">bates-color</replaceable></option></arg>
                 <arg><option>-d <replaceable class="parameter">debug-file</replaceable></option></arg>
-                <arg><option>-f <replaceable class="parameter">ttf-font-file</replaceable></option></arg>
+                <arg choice='plain'>-f <replaceable class="parameter">ttf-font-file</replaceable></arg>
                 <arg><option>-h</option></arg>
                 <arg><option>-o <replaceable class="parameter">output-directory</replaceable></option></arg>
                 <arg choice='plain'>pstfilename</arg>