From 5d0de5ed03925b5d2e475105a0b4ed01bb6f56be Mon Sep 17 00:00:00 2001
From: Mattias Andrée <maandree@kth.se>
Date: Mon, 22 Feb 2021 15:52:10 +0100
Subject: Add man page
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Mattias Andrée <maandree@kth.se>
---
 Makefile   |   3 ++
 config.mk  |   4 +--
 file2key.1 | 113 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 118 insertions(+), 2 deletions(-)
 create mode 100644 file2key.1

diff --git a/Makefile b/Makefile
index 6707703..48bc8fb 100644
--- a/Makefile
+++ b/Makefile
@@ -13,10 +13,13 @@ file2key.o: file2key.c settings.h config.h
 
 install: file2key
 	mkdir -p -- "$(DESTDIR)$(PREFIX)/bin"
+	mkdir -p -- "$(DESTDIR)$(MANPREFIX)/man1"
 	cp -- file2key "$(DESTDIR)$(PREFIX)/bin/"
+	cp -- file2key.1 "$(DESTDIR)$(MANPREFIX)/man1/"
 
 uninstall:
 	-rm -f -- "$(DESTDIR)$(PREFIX)/bin/file2key"
+	-rm -f -- "$(DESTDIR)$(MANPREFIX)/man1/file2key.1"
 
 clean:
 	-rm -rf -- *.o file2key
diff --git a/config.mk b/config.mk
index b8c111e..93a9878 100644
--- a/config.mk
+++ b/config.mk
@@ -1,5 +1,5 @@
-PREFIX = /usr/local
-MANPREFIX = $(CONFIGFILE)
+PREFIX = /usr
+MANPREFIX = $(PREFIX)/share/man
 
 CFLAGS   = -std=c99 -Wall -Wextra -O2
 CPPFLAGS = -D_DEFAULT_SOURCE -D_BSD_SOURCE -D_XOPEN_SOURCE=700
diff --git a/file2key.1 b/file2key.1
new file mode 100644
index 0000000..211bf3a
--- /dev/null
+++ b/file2key.1
@@ -0,0 +1,113 @@
+.TH FILE2KEY 8 file2key
+
+.SH NAME
+file2key - generates a key from a file and a passphrase
+
+.SH SYNOPSIS
+.B file2key
+.RI [ file ]
+
+.SH DESCRIPTION
+.B file2key
+uses Keccak[] to create a hash as big as a selected
+file and the prints the bitwise exclusive or of the
+hash and the file making a key file from any normal
+file and a passphrase.
+.PP
+The idea is the reversed of steganography.
+.PP
+.B file2key
+can also be used to encrypt and decrypt files.
+
+.SH OPTIONS
+The
+.B file2key
+utility conforms to the Base Definitions volume of POSIX.1-2017,
+.IR "Section 12.2" ,
+.IR "Utility Syntax Guidelines" .
+.PP
+No options are supported.
+
+.SH OPERANDS
+The following operands are supported:
+.TP
+.I file
+The file to generate a key from.
+
+.SH STDIN
+The
+.B file2key
+utility generate a key from the standard input is no
+.I file
+is specified, or if the specified file is
+.RB \(dq - \(dq.
+
+.SH INPUT FILES
+The input file can be any file type.
+
+.SH ENVIRONMENT VARIABLES
+No environment variables affects the execution of
+.BR file2key
+
+.SH ASYNCHRONOUS EVENTS
+Default.
+
+.SH STDOUT
+The
+.B file2key
+utility prints the input
+.I file
+bitwise XORed with the hash of the passphrase
+to the standard output.
+
+.SH STDERR
+The standard error is used for diagnostic messages and the
+passphrase prompt.
+
+.SH OUTPUT FILES
+None.
+
+.SH EXTENDED DESCRIPTION
+None.
+
+.SH EXIT STATUS
+If the
+.B asroot
+utility fails it will exit withone of the following statuses:
+.TP
+0
+Successful completion.
+.TP
+1
+User error.
+.TP
+2
+An error occurred.
+
+.SH CONSEQUENCES OF ERRORS
+Default.
+
+.SH APPLICATION USAGE
+None.
+
+.SH EXAMPLES
+None.
+
+.SH RATIONALE
+.B file2key
+cannot be configured. The idea behind this is that you
+if it required configurations you run the risk of losing
+all your keys if you lose your configurations. This must
+not happen.
+
+.SH NOTES
+None.
+
+.SH BUGS
+None.
+
+.SH FUTURE DIRECTIONS
+None.
+
+.SH SEE ALSO
+None.
-- 
cgit v1.2.3-70-g09d2