add docs
This commit is contained in:
parent
845eddafd4
commit
97c5d07f6c
4
Makefile
4
Makefile
@ -3,5 +3,7 @@ include config.mk
|
|||||||
all: src/main.c
|
all: src/main.c
|
||||||
$(CC) $(CFLAGS) $(LDFLAGS) src/main.c -o src/ecrypt
|
$(CC) $(CFLAGS) $(LDFLAGS) src/main.c -o src/ecrypt
|
||||||
|
|
||||||
install: src/ecrypt
|
install: src/ecrypt man/ecrypt.1
|
||||||
install src/ecrypt $(PREFIX)/bin
|
install src/ecrypt $(PREFIX)/bin
|
||||||
|
install -g 0 -o 0 -m 0644 man/ecrypt.1 /usr/local/man/man1
|
||||||
|
gzip /usr/local/man/man1/ecrypt.1
|
||||||
|
16
man/ecrypt.1
Normal file
16
man/ecrypt.1
Normal file
@ -0,0 +1,16 @@
|
|||||||
|
.\" Manpage for ecrypt.
|
||||||
|
.TH man 1 "24 March 2023" "1.0" "Everest Tools Manual"
|
||||||
|
.SH NAME
|
||||||
|
ecrypt \- generate a random string of letters, numbers, and symbols
|
||||||
|
.SH SYNOPSIS
|
||||||
|
ecrypt
|
||||||
|
.SH DESCRIPTION
|
||||||
|
ecrypt is a string generator, which can be used for generating passwords or keys. The length of the password can be customized by changing the value of PASSWD_LENGTH in src/config.h.
|
||||||
|
.SH OPTIONS
|
||||||
|
ecrypt does not take any options.
|
||||||
|
.SH SEE ALSO
|
||||||
|
esv(1)
|
||||||
|
.SH BUGS
|
||||||
|
No known bugs.
|
||||||
|
.SH AUTHOR
|
||||||
|
Liam Waldron (liamwaldron@everestlinux.org)
|
Loading…
Reference in New Issue
Block a user