diff --git a/README.md b/README.md index 7ed9d09..f1f3e39 100644 --- a/README.md +++ b/README.md @@ -4,12 +4,12 @@ letsrenew is a python script that is able to retrieve a certificate from a host, ## requirements -Probably ''python3-openssl'' should be installed on your system. The provided binary has everything bundled. -To use the build script you need ''pyinstaller'' and ''fpm''. +Probably `python3-openssl` should be installed on your system. The provided binary has everything bundled. +To use the build script you need `pyinstaller` and `fpm`. ## instructions -The provided ''build.sh'' script should give you both a binary version as well as a debian package inside a ''dist'' directory. +The provided `build.sh` script should give you both a binary version as well as a debian package inside a `dist` directory. ## usage ``` @@ -21,11 +21,11 @@ positional arguments: hostname Hostname that will be requested from the webserver. optional arguments: - -h, --help show this help message and exit + -h, --help show this help message and exit. -a ADDRESS, --address ADDRESS - Alternate address to connect (don't resolve the hostname). + Alternate address to connect (to circumvent proxies, balancers, etc...). -p PORT, --port PORT Alternate port to connect to. - -j, --json Output in JSON fromat. + -j, --json Output in JSON format. -l ALERT, --alert ALERT Output only on alerts. Specify it as the validity threshold in days. 0 for Always output (default). @@ -65,4 +65,4 @@ This program is free software: you can redistribute it and/or modify it under th This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. -You should have received a copy of the GNU General Public License along with this program. If not, see . +You should have received a copy of the GNU General Public License along with this program. If not, see . \ No newline at end of file diff --git a/letsrenew.py b/letsrenew.py index 5c73a77..6b7c3c2 100755 --- a/letsrenew.py +++ b/letsrenew.py @@ -100,11 +100,11 @@ def parse_arguments(): parser.add_argument("hostname", action="store", help="Hostname that will be requested from the webserver.") parser.add_argument("-a", "--address", - action="store", required=False, help="Alternate address to connect (don't resolve the hostname).") + action="store", required=False, help="Alternate address to connect (to circumvent proxies, balancers, etc...).") parser.add_argument("-p", "--port", default=443, type=int, action="store", required=False, help="Alternate port to connect to.") parser.add_argument("-j", "--json", default=False, - action="store_true", required=False, help="Output in JSON fromat.") + action="store_true", required=False, help="Output in JSON format.") parser.add_argument("-l", "--alert", default=0, type=int, action="store", required=False, help="Output only on alerts. Specify it as the validity threshold in days. 0 for Always output (default).")