about summary refs log tree commit diff
path: root/README
diff options
context:
space:
mode:
authorLeah Neukirchen <leah@vuxu.org>2024-10-02 18:32:53 +0200
committerLeah Neukirchen <leah@vuxu.org>2024-10-02 18:32:53 +0200
commit945bc437108bd0bec6ffbd4e62d2eb5a4e7ba941 (patch)
tree84522a2d1fba27b4c8e6901af434c12b80fcca51 /README
downloadulidgen-945bc437108bd0bec6ffbd4e62d2eb5a4e7ba941.tar.gz
ulidgen-945bc437108bd0bec6ffbd4e62d2eb5a4e7ba941.tar.xz
ulidgen-945bc437108bd0bec6ffbd4e62d2eb5a4e7ba941.zip
initial import of ulidgen
Diffstat (limited to 'README')
-rw-r--r--README46
1 files changed, 46 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..c4be216
--- /dev/null
+++ b/README
@@ -0,0 +1,46 @@
+ULIDGEN(1)                  General Commands Manual                 ULIDGEN(1)
+
+NAME
+     ulidgen – generate or tag lines with ULID
+
+SYNOPSIS
+     ulidgen [-n N] [-t]
+
+DESCRIPTION
+     ulidgen generates and prints one or multiple ULID (Universally Unique
+     Lexicographically Sortable Identifier).
+
+     The options are as follows:
+
+     -n N    Print N consecutive ULID.
+
+     -t      Read lines from standard input, and prefix each line with a ULID.
+
+EXIT STATUS
+     The ulidgen utility exits 0 on success, and >0 if an error occurs.
+
+EXAMPLES
+     Generating three ULID:
+
+           % ulidgen -n 3
+           01J970QT8Y3F9H32BHX76RRS7T
+           01J970QT8Y3F9H32BHX76RRS7V
+           01J970QT8Y3F9H32BHX76RRS7W
+
+SEE ALSO
+     https://github.com/ulid/spec#specification
+
+     uuidgen(1)
+
+AUTHORS
+     Leah Neukirchen <leah@vuxu.org>
+
+LICENSE
+     ulidgen is in the public domain.
+
+     To the extent possible under law, the creator of this work has waived all
+     copyright and related or neighboring rights to this work.
+
+     http://creativecommons.org/publicdomain/zero/1.0/
+
+Void Linux                      October 2, 2024                     Void Linux