diff --git a/README.md b/README.md index c33a857..b7adee1 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,31 @@ # man2html -just a script 4 fast manpage outputs \ No newline at end of file +Convert manpages to HTML documents. + +## Usage + +`man2html` takes the name of a manpage as an argument, so you don't need to specify the manpage by its path. + +``` +$ man2html termux +``` + +`man2html` allways outputs to stdout. You can save the generated html page using output redirection in your shell, like this: +``` +$ man2html termux > termux_manpage.html +``` + +## Installation + +Copy the script somewhere in your $PATH. Clone or download .zip manually. + +``` +git clone "https://gitea.dmz.rs/disu1950/man2html" +cd man2html +cp man2html /data/data/com.termux/files/home/.local/bin +chmod +x /data/data/com.termux/files/home/.local/bin/man2html +``` + +## License + +This project is licensed under the WTF Public License, version 3. \ No newline at end of file