diff --git a/README.md b/README.md index 622cee1..78f3258 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,24 @@ checkpw is a program that checks the validity of a users password on a Linux/PAM-based system. +## The idea behind: + +Exactly a program like this... + +# Installation: + +``` +git clone https://git.xw3.org/hanez/checkpw.git +cd checkpw +make +sudo make install +``` + +# Usage: +# checkpw - 1.0 + +checkpw is a program that checks the validity of a users password on a Linux/PAM-based system. + ## They idea? Exactly a program like this... @@ -34,3 +52,20 @@ Returns 0 on success, 1 otherwise. echo $? ``` +``` +./checkpw [-u ] [-p ] [-i] [-v] [-h] + +Options: + -u Specify username. + -p Specify password. + -i Enable interactive mode to prompt for missing username/password. + -v Enable verbose mode. + -h Show this help +``` + +Returns 0 on success, 1 otherwise. + +``` +echo $? +``` +