diff --git a/README b/README index b308e97..3df3ad9 100644 --- a/README +++ b/README @@ -4,13 +4,13 @@ A library which provides a random string generation function. + Usage - #include + #include int main() { - ecrypt(PASSWD_LENGTH); + ecrypt(LENGTH); } - (user)$ gcc prog.c -L. -lecrypt -o prog + (user)$ gcc prog.c -lecrypt -o prog + Installation diff --git a/include/libecrypt.h b/include/ecrypt.h similarity index 100% rename from include/libecrypt.h rename to include/ecrypt.h diff --git a/man/libecrypt.3 b/man/libecrypt.3 new file mode 100644 index 0000000..2e3e05d --- /dev/null +++ b/man/libecrypt.3 @@ -0,0 +1,18 @@ +.\" Manpage for libecrypt. +.TH man 3 "11 May 2023" "1.0" "Everest Linux Libraries Manual" +.SH NAME +libecrypt \- random string generation library +.SH SYNOPSIS +#include + +ecrypt(LENGTH); + +(user)$ gcc -lecrypt prog.c -o prog +.SH DESCRIPTION +libecrypt is a library that provides random string generation, similar to ecyrpt(1). It is provided as a static library only. +.SH SEE ALSO +libcolor(3) +.SH BUGS +Report all bugs on the issues page at https://git.everestlinux.org/EverestLinux/libecrypt +.SH AUTHOR +Liam Waldron (liamwaldron@everestlinux.org)