1 files changed, 69 insertions, 0 deletions
diff --git a/doc/upwgen.1 b/doc/upwgen.1
new file mode 100644
index 0000000..e919b22
--- /dev/null
+++ b/doc/upwgen.1
@@ -0,0 +1,69 @@
+.TH UPWGEN 1 "{{ RELDATE }}" "pwgen version {{ VERSTR }}"
+.SH NAME
+upwgen \- generate international (utf-8) passwords
+.SH SYNOPSIS
+.B upwgen
+[
+.I OPTIONS
+]
+[
+.I pw_length
+]
+.SH DESCRIPTION
+The
+.B upwgen
+program generates passwords which include international characters,
+significantly increasing password complexity. These passwords are not only
+designed to be difficult to memorize, but are also nearly impossible to type as
+they will usually span multiple character sets, requiring multiple keyboard
+locales. By design, the passwords generated by upwgen are intended to be copied
+and pasted.
+
+The default mode of operation if no arguments are specified is to print a
+password of 32 characters long, selected from the printable English ascii
+character pool (94 characters total).
+.B
+.SH OPTIONS
+.TP
+.B \-c, --capitalize
+Include at least one capital letter in the password.
+.TP
+.B \-l, --lower
+Include at least one lower case letter in the password.
+.TP
+.B \-n, --numerals
+Include at least one number in the password.
+.TP
+.B \-y, --symbols
+Include at least one special character in the password. 
+.TP
+.B \-1
+Include chars from the most used scripts in the world
+.TP
+.B \-2
+Include chars from the second most used scripts in the world
+.TP
+.B \-3
+Include chars from the third most used scripts in the world
+.TP
+.B \-4
+Include chars from the forth most used scripts in the world
+.TP
+.B \-i, --i18n
+Include all supported international characters (same as -1 -2 -3 -4)
+.TP
+.B \-h, --help
+Print the help text
+.TP
+.B \-V, --version
+Print the version
+.TP
+.B \-d, --debug
+Enable debug mode (prints entire selected character pool)
+.SH AUTHOR
+.B Upwgen
+was written by Aaron Ball <nullspoon@oper.io>.  
+It is modelled after pwgen, a program written by Theodore Ts'o.
+.SH SEE ALSO
+.BR passwd (1)
+.BR pwgen (1)