Changeset 2513

Timestamp:

10/14/06 07:22:10 (6 years ago)

Author:

mschaber

Message:

sanitized usage info output on loader/dumper

Location:

trunk

Files:

• CHANGES (modified) (1 diff)
• doc/man/pgsql2shp.1 (modified) (1 diff)
• doc/man/shp2pgsql.1 (modified) (1 diff)
• loader/pgsql2shp.c (modified) (6 diffs)
• loader/README.pgsql2shp (modified) (1 diff)
• loader/README.shp2pgsql (modified) (1 diff)
• loader/shp2pgsql.c (modified) (5 diffs)

trunk/CHANGES

@@ -5 +5 @@
         - Include the Version.config in loader/dumper USAGE messages
         - Replace hand-made, fragile JDBC version parser with Properties
+        - Sanitized usage output of loader/dumper.
 
 

trunk/doc/man/pgsql2shp.1

@@ -67 +67 @@
 \fB\-k\fR
 Keep idendifiers case (don't uppercase field names). 
+.TP 
+\fB\-?\fR
+Display version and usage information.
 
 .SH "INSTALLATION"

trunk/doc/man/shp2pgsql.1

@@ -89 +89 @@
 \fB\-N\fR <\fIpolicy\fR>
 Specify NULL geometries handling policy (insert,skip,abort).
+.TP 
+\fB\-?\fR
+Display version and usage information.
 
 .SH "INSTALLATION"

trunk/loader/pgsql2shp.c

@@ -94 +94 @@
 int getMaxFieldSize(PGconn *conn, char *schema, char *table, char *fname);
 int parse_commandline(int ARGC, char **ARGV);
-void usage(int exitstatus);
+void usage(char* me, int exitstatus, FILE* out);
 char *getTableOID(char *schema, char *table);
 int addRecord(PGresult *res, int residx, int row);
@@ -195 +195 @@
         if ( getenv("ROWBUFLEN") ) rowbuflen=atoi(getenv("ROWBUFLEN"));
 
-        if ( ARGC == 1 ) {
-                usage(0);
-        }
-
         /*
          * Make sure dates are returned in ISO
@@ -210 +206 @@
         if ( ! parse_commandline(ARGC, ARGV) ) {
                 printf("\n**ERROR** invalid option or command parameters\n\n");
-                usage(2);
+                usage(ARGV[0], 2, stderr);
         }
 
@@ -2309 +2305 @@
 
 void
-usage(int status)
-{
-        printf("RCSID: %s RELEASE: %s\n", rcsid, POSTGIS_VERSION);
-        printf("USAGE: pgsql2shp [<options>] <database> [<schema>.]<table>\n");
-        printf("       pgsql2shp [<options>] <database> <query>\n");
-        printf("\n");
-        printf("OPTIONS:\n");
-        printf("  -f <filename>  Use this option to specify the name of the file\n");
-        printf("     to create.\n");
-        printf("  -h <host>  Allows you to specify connection to a database on a\n");
-        printf("     machine other than the default.\n");
-        printf("  -p <port>  Allows you to specify a database port other than the default.\n");
-        printf("  -P <password>  Connect to the database with the specified password.\n");
-        printf("  -u <user>  Connect to the database as the specified user.\n");
-        printf("  -g <geometry_column> Specify the geometry column to be exported.\n");
-        printf("  -b Use a binary cursor.\n");
-        printf("  -r Raw mode. Do not assume table has been created by \n");
-        printf("     the loader. This would not unescape attribute names\n");
-        printf("     and will not skip the 'gid' attribute.\n");
-        printf("  -k Keep postgresql identifiers case.\n");
-        printf("\n");
+usage(char* me, int status, FILE* out)
+{
+        fprintf(out,"RCSID: %s RELEASE: %s\n", rcsid, POSTGIS_VERSION);
+        fprintf(out,"USAGE: %s [<options>] <database> [<schema>.]<table>\n", me);
+        fprintf(out,"       %s [<options>] <database> <query>\n", me);
+        fprintf(out,"\n");
+        fprintf(out,"OPTIONS:\n");
+        fprintf(out,"  -f <filename>  Use this option to specify the name of the file\n");
+        fprintf(out,"     to create.\n");
+        fprintf(out,"  -h <host>  Allows you to specify connection to a database on a\n");
+        fprintf(out,"     machine other than the default.\n");
+        fprintf(out,"  -p <port>  Allows you to specify a database port other than the default.\n");
+        fprintf(out,"  -P <password>  Connect to the database with the specified password.\n");
+        fprintf(out,"  -u <user>  Connect to the database as the specified user.\n");
+        fprintf(out,"  -g <geometry_column> Specify the geometry column to be exported.\n");
+        fprintf(out,"  -b Use a binary cursor.\n");
+        fprintf(out,"  -r Raw mode. Do not assume table has been created by \n");
+        fprintf(out,"     the loader. This would not unescape attribute names\n");
+        fprintf(out,"     and will not skip the 'gid' attribute.\n");
+        fprintf(out,"  -k Keep postgresql identifiers case.\n");
+        fprintf(out,"  -? Display this help screen.\n");
+        fprintf(out,"\n");
         exit (status);
 }
@@ -2337 +2334 @@
 parse_commandline(int ARGC, char **ARGV)
 {
+        if ( ARGC == 1 ) {
+                usage(ARGV[0], 0, stdout);
+        }
+
         int c, curindex;
         char buf[1024];
@@ -2386 +2387 @@
                                 break;
                         case '?':
+                                usage(ARGV[0], 0, stdout);
                         default:
                                 return 0;

trunk/loader/README.pgsql2shp

@@ -66 +66 @@
        -k     Keep idendifiers case (don't uppercase field names).
 
+       -?     Display version and usage information.
+
 
 INSTALLATION

trunk/loader/README.shp2pgsql

@@ -89 +89 @@
               Specify NULL geometries handling policy (insert,skip,abort).
 
+       -?     Display version and usage information.
+
 
 INSTALLATION

trunk/loader/shp2pgsql.c

@@ -107 +107 @@
 void CreateTable(void);
 void CreateIndex(void);
-void usage(char *me, int exitcode);
+void usage(char *me, int exitcode, FILE* out);
 void InsertPoint(void);
 void InsertPointWKT(void);
@@ -382 +382 @@
          * Parse command line
          */
-        if ( ! ParseCmdline(ARGC, ARGV) ) usage(ARGV[0], 2);
+        if ( ! ParseCmdline(ARGC, ARGV) ) usage(ARGV[0], 2, stderr);
 
         /*
@@ -732 +732 @@
 
 void
-usage(char *me, int exitcode)
-{
-        fprintf(stderr, "RCSID: %s RELEASE: %s\n", rcsid, POSTGIS_VERSION);
-        fprintf(stderr, "USAGE: %s [<options>] <shapefile> [<schema>.]<table>\n", me);
-        fprintf(stderr, "\n");
-        fprintf(stderr, "OPTIONS:\n");
-        fprintf(stderr, "  -s <srid>  Set the SRID field. If not specified it defaults to -1.\n");
-        fprintf(stderr, "\n");
-        fprintf(stderr, "  (-d|a|c|p) These are mutually exclusive options:\n");
-        fprintf(stderr, "      -d  Drops the table, then recreates it and populates\n");
-        fprintf(stderr, "          it with current shape file data.\n");
-        fprintf(stderr, "      -a  Appends shape file into current table, must be\n");
-        fprintf(stderr, "          exactly the same table schema.\n");
-        fprintf(stderr, "      -c  Creates a new table and populates it, this is the\n");
-        fprintf(stderr, "          default if you do not specify any options.\n");
-        fprintf(stderr, "      -p  Prepare mode, only creates the table\n");
-        fprintf(stderr, "\n");
-        fprintf(stderr, "  -g <geometry_column> Specify the name of the geometry column\n");
-        fprintf(stderr, "     (mostly useful in append mode).\n");
-        fprintf(stderr, "\n");
-        fprintf(stderr, "  -D  Use postgresql dump format (defaults to sql insert\n");
-        fprintf(stderr, "      statments.\n");
-        fprintf(stderr, "\n");
-        fprintf(stderr, "  -k  Keep postgresql identifiers case.\n");
-        fprintf(stderr, "\n");
-        fprintf(stderr, "  -i  Use int4 type for all integer dbf fields.\n");
-        fprintf(stderr, "\n");
-        fprintf(stderr, "  -I  Create a GiST index on the geometry column.\n");
-        fprintf(stderr, "\n");
-        fprintf(stderr, "  -S  Generate simple geometries instead of MULTI geometries.\n");
-        fprintf(stderr, "\n");
-        fprintf(stderr, "  -w  Use wkt format (for postgis-0.x support - drops M - drifts coordinates).\n");
+usage(char *me, int exitcode, FILE* out)
+{
+        fprintf(out, "RCSID: %s RELEASE: %s\n", rcsid, POSTGIS_VERSION);
+        fprintf(out, "USAGE: %s [<options>] <shapefile> [<schema>.]<table>\n", me);
+        fprintf(out, "OPTIONS:\n");
+        fprintf(out, "  -s <srid>  Set the SRID field. If not specified it defaults to -1.\n");
+        fprintf(out, "  (-d|a|c|p) These are mutually exclusive options:\n");
+        fprintf(out, "      -d  Drops the table, then recreates it and populates\n");
+        fprintf(out, "          it with current shape file data.\n");
+        fprintf(out, "      -a  Appends shape file into current table, must be\n");
+        fprintf(out, "          exactly the same table schema.\n");
+        fprintf(out, "      -c  Creates a new table and populates it, this is the\n");
+        fprintf(out, "          default if you do not specify any options.\n");
+        fprintf(out, "      -p  Prepare mode, only creates the table.\n");
+        fprintf(out, "  -g <geometry_column> Specify the name of the geometry column\n");
+        fprintf(out, "     (mostly useful in append mode).\n");
+        fprintf(out, "  -D  Use postgresql dump format (defaults to sql insert statments.\n");
+        fprintf(out, "  -k  Keep postgresql identifiers case.\n");
+        fprintf(out, "  -i  Use int4 type for all integer dbf fields.\n");
+        fprintf(out, "  -I  Create a GiST index on the geometry column.\n");
+        fprintf(out, "  -S  Generate simple geometries instead of MULTI geometries.\n");
+        fprintf(out, "  -w  Use wkt format (for postgis-0.x support - drops M - drifts coordinates).\n");
 #ifdef USE_ICONV
-        fprintf(stderr, "\n");
-        fprintf(stderr, "  -W <encoding> Specify the character encoding of Shape's\n");
-        fprintf(stderr, "     attribute column. (default : \"ASCII\")\n");
+        fprintf(out, "  -W <encoding> Specify the character encoding of Shape's\n");
+        fprintf(out, "     attribute column. (default : \"ASCII\")\n");
 #endif
-        fprintf(stderr, "\n");
-        fprintf(stderr, "  -N <policy> Specify NULL geometries handling policy (insert,skip,abort)\n");
+        fprintf(out, "  -N <policy> Specify NULL geometries handling policy (insert,skip,abort)\n");
+        fprintf(out, "  -? Display this help screen\n");
         exit (exitcode);
 }
@@ -1279 +1268 @@
         extern char *optarg;
         extern int optind;
+
+        if ( ARGC == 1 ) {
+                usage(ARGV[0], 0, stdout);
+        }
 
         while ((c = getopt(ARGC, ARGV, "kcdapDs:Sg:iW:wIN:")) != EOF){
@@ -1355 +1348 @@
                     break;
                case '?':
+                    usage(ARGV[0], 0, stdout); 
                default:              
                 return 0;