]> pd.if.org Git - uuid/blobdiff - uuidgen.1
added command line uuidgen program
[uuid] / uuidgen.1
diff --git a/uuidgen.1 b/uuidgen.1
new file mode 100644 (file)
index 0000000..6eaca28
--- /dev/null
+++ b/uuidgen.1
@@ -0,0 +1,55 @@
+.TH uuidgen 1 "Tue Sep 23 09:54:24 UTC 2014"
+.SH NAME
+
+uuidgen - command line utility for generating uuids
+
+.SH SYNOPSIS
+
+uuidgen [-tvnqODUX]
+
+uuidgen [-n ns | -UXD] name ...
+
+.SH DESCRIPTION
+
+This program generates uuids and writes their canonical string representation
+to stdout.
+
+.SH OPTIONS
+
+.TP
+.BI \-r
+Generate a version 4 random uuid.
+.TP
+.BI \-t
+Generate a version 1 timestamp based uuid
+.TP
+.B \-n " namespace | oid | dns | x500 | url"
+set the namespace for version 3 or version 5 uuids
+.TP
+.B \-q num
+Specify how many uuids to generate for version 1 and 4 uuids.  UUIDs will
+be output one per line on stdout.
+.TP
+.B \-h
+Write a help message to stdout and exit.
+
+.SH DIAGNOSTICS
+
+The program will exit 0 on success, and non zero on failure.  Running
+witht the \-h or \-V switches will write the appropriate message
+to stdout and exit successfully.
+
+Errors will generate a message to stderr and nothing to stdout, as
+well as exiting non-zero.
+
+.SH BUGS
+
+.SH AUTHOR
+
+Nathan Wagner
+.I
+<nw@hydaspes.if.org>
+
+.SH COPYRIGHT
+
+None.  Program is in the public domain.