From 8082a4dcdd46369f4014e36a352af595f2a94afb Mon Sep 17 00:00:00 2001
From: ts5746 <timo@whiteflagprotocol.org>
Date: Sun, 27 Oct 2019 12:51:12 +0100
Subject: [PATCH] Added man page

---
 README.md       | 13 +++++----
 doc/man/wfwhl.1 | 74 +++++++++++++++++++++++++++++++++++++++++++++++++
 package.json    |  3 +-
 3 files changed, 83 insertions(+), 7 deletions(-)
 create mode 100644 doc/man/wfwhl.1

diff --git a/README.md b/README.md
index 99350e9..12502b5 100644
--- a/README.md
+++ b/README.md
@@ -2,14 +2,15 @@
 
 ## Introduction
 
+Whiteflag is a fully neutral and secure communciations means based on
+blockchain technology. It enables near real-time communication in armed
+conflicts and disasters to exchange early warning and status information
+to create shared situational awareness.
+
 This Whiteflag utility is a [Node.js](https://nodejs.org/en/about/) command
 line interface (CLI) that creates and sends Whiteflag messages for specified
-cultural heritage sites listed on the UNESCO World Heritage List.
-
-Sending a Whiteflag message is the digital equivalent of placing a physical
-protective sign. Whiteflag is a fully neutral and secure communciations means
-that allows near real-time communication in conflicts to exchange early
-warning and status information to create shared situational awareness.
+cultural heritage sites listed on the UNESCO World Heritage List. This is the
+digital equivalent of placing a physical protective sign.
 
 Note that this utility only processes *cultural* heritage sites, because
 Whiteflag (currently) only defines a message (`P52`) that corresponds with the
diff --git a/doc/man/wfwhl.1 b/doc/man/wfwhl.1
new file mode 100644
index 0000000..9582ace
--- /dev/null
+++ b/doc/man/wfwhl.1
@@ -0,0 +1,74 @@
+.TH WFWHL 1
+.SH NAME
+wfwhl \- send protective signs for WHL sites with Whiteflag
+.SH SYNOPSIS
+.B wfwhl
+[\fI\,OPTION\/\fR]...
+.SH DESCRIPTION
+Create and send Whiteflag messages for specified cultural heritage sites listed
+on the UNESCO World Heritage List, which is the digital equivalent of placing a
+physical protective sign.
+.PP
+Whiteflag is a fully neutral and secure communciations means based on
+blockchain technology. It enables near real-time communication in armed
+conflicts and disasters to exchange early warning and status information
+to create shared situational awareness.
+.SH OPTIONS
+.TP
+.BR \-s ", " \-\-sites =\fISITEID\fR
+Specify the world heritage site(s) to be processed by \fISITEID\fR number; multiple
+sites may be specified. If no sites are specified, all sites are processed.
+.TP
+.BR \-w ", " \-\-web =\fIURL\fR
+The source \fIURL\fR of the WHL in XML on the web. If not specified the default is
+\fIhttps://whc.unesco.org/en/list/xml/\fR. Cannot be used with \fB\-f\fR.
+.TP
+.BR \-f ", " \-\-file =\fIFILE\fR
+The source \fIFILE\fR containing the WHL in XML. Cannot be used with \fB\-w\fR.
+.TP
+.BR \-t ", " \-\-transmit
+(NOT IMPLEMENTED) Transmit the Whiteflag message(s) on the blockchain. Requires \fB\-i\fR,
+\fB\-b\fR and \fB\-a\fR to be specified, either on the command line or using
+a configuration file with \fB\-\-config\fR.
+.TP
+.BR \-i ", " \-\-interface =\fIURL\fR
+(NOT IMPLEMENTED) The Whiteflag API REST interface \fIURL\fR to post the message(s) to be sent.
+.TP
+.BR \-b ", " \-\-blockchain =\fIBLOCKCHAIN\fR
+(NOT IMPLEMENTED) The \fIBLOCKCHAIN\fR to be used for sending the message(s).
+.TP
+.BR \-a ", " \-\-address =\fIADDRESS\fR
+(NOT IMPLEMENTED) The blockchain \fIADDRESS\fR to be used for sending the message(s).
+.TP
+.BR \-o ", " \-\-stdout
+Send the Whiteflag message(s) to stdout. This allows the data to be piped to other processes.
+.TP
+.BR \-v ", " \-\-verbose
+Provide detailed processing output.
+.TP
+.BR \-\-help
+Show help message.
+.TP
+.BR \-\-version
+Show version number.
+.TP
+.BR \-\-config =\fIFILE\fR
+Path to a JSON config \fIFILE\fR with preconfigured arguments; especially useful to
+specify Whiteflag API interface URL, blockchain and address.
+.SH LEGAL
+THE USAGE OF SIGNS AND SIGNALS WITH THIS SOFTWARE IS SUBJECT TO LOCAL AND/OR INTERNATIONAL LAWS
+.PP
+The Whiteflag WHL utility is dedicated to the public domain under the
+Creative Commons CC0-1.0 Universal Public Domain Dedication statement.
+Note that this only applies to this software, and that this
+explicitly DOES NOT imply endorsement or permission by UNESCO to use
+WHL information, which is subject to the terms and policies of the
+UNESCO World Heritage Centre.
+.PP
+The usage of protective signs is subject to International Humanitarian
+Law. Misuse of protective signs is a punishable violation under local
+and international laws. This utility only provides an additional means of
+communication for certain signs and signals, and it does not replace any
+existing standard, regulation or means of communication, whether mandatory
+or not, including but not limited to physical signs, radio communications,
+official registers, etc.
diff --git a/package.json b/package.json
index 7cd8bb0..d1b5236 100644
--- a/package.json
+++ b/package.json
@@ -32,7 +32,8 @@
     "directories": {
         "lib": "./lib",
         "test": "./test",
-        "doc": "./doc"
+        "doc": "./doc",
+        "man": "./doc/man"
     },
     "main": "main.js",
     "bin": {