commit 77c7c5b

readme

1@@ -0,0 +1 @@
2+readme.html

 1@@ -4,8 +4,6 @@
 2 PROG=haslo
 3 MAN=haslo.1
 4 
 5-CP=cp
 6-
 7 PREFIX=/usr/local
 8 BINDIR=${PREFIX}/bin
 9 MANDIR=${PREFIX}/man
10@@ -25,3 +23,9 @@ install:
11 	sed '1s:.*:#!${PERLSHEBANG}:' ${PROG} > ${BINDIR}/${PROG}
12 	chmod +x ${BINDIR}/${PROG}
13 	cp ${MAN} ${MAN1}/${MAN}
14+
15+readme.html: readme.7
16+	mandoc -Thtml -Ofragment readme.7 > readme.html
17+
18+uploadreadme: readme.html
19+	hut git update --readme readme.html --repo https://git.sr.ht/~emilia/haslo

 1@@ -0,0 +1,58 @@
 2+.Dd $Mdocdate$
 3+.Dt README 7
 4+.Os Repository description
 5+.Sh NAME
 6+.Nm haslo
 7+.Nd a simple password manager
 8+.Sh SYNOPSIS
 9+See
10+.Xr haslo 1 .
11+.Sh DEPENDENCIES
12+.Bl -dash -width 1n
13+.It
14+.Nm perl
15+.It
16+The
17+.Nm perl
18+modules
19+.Em MIME::Base64
20+and
21+.Em Term::ReadKey
22+(may already be provided by the system
23+.Nm perl
24+distribution)
25+.It
26+.Nm gpg
27+.El
28+.Sh INSTALLATION
29+Run
30+.Nm make
31+to check for the required
32+.Nm perl
33+modules, then
34+.Nm doas Nm make Cm install
35+to install.
36+.Sh MAKE OPTIONS
37+Apart from the standard variables such as
38+.Ev PREFIX ,
39+.Ev BINDIR ,
40+.Ev MANDIR ,
41+the
42+.Pa Makefile
43+for
44+.Nm
45+uses the following variables that may be overridden by the user:
46+.Bl -tag -width Ds
47+.It Ev PERLSHEBANG
48+The command to execute
49+.Nm perl .
50+Used to check for the required
51+.Nm perl
52+modules, and set as the shebang of the installed executable. Defaults to
53+.Pa /usr/bin/env Nm perl .
54+.El
55+.Sh LICENSE
56+.Nm
57+is public domain software.
58+.Sh AUTHORS
59+.An Emilia Smólska Aq Mt emilia@hopeserv.net