From f171a21cdd1b3feddc637e8bdc059024d6baf8bb Mon Sep 17 00:00:00 2001 From: hwdsl2 Date: Sun, 4 Aug 2024 21:38:23 -0500 Subject: [PATCH] Update docs --- README-zh.md | 29 ++++++++++++++--------------- README.md | 29 ++++++++++++++--------------- docs/clients-zh.md | 29 ++++++++++++++--------------- docs/clients.md | 29 ++++++++++++++--------------- 4 files changed, 56 insertions(+), 60 deletions(-) diff --git a/README-zh.md b/README-zh.md index 1b74cf3..273ace4 100644 --- a/README-zh.md +++ b/README-zh.md @@ -122,24 +122,23 @@ Usage: bash openvpn.sh [options] Options: - --addclient [client name] add a new client - --exportclient [client name] export configuration for an existing client - --listclients list the names of existing clients - --revokeclient [client name] revoke an existing client - --uninstall remove OpenVPN and delete all configuration - -y, --yes assume "yes" as answer to prompts when revoking a client or removing OpenVPN - -h, --help show this help message and exit + --addclient [client name] add a new client + --exportclient [client name] export configuration for an existing client + --listclients list the names of existing clients + --revokeclient [client name] revoke an existing client + --uninstall remove OpenVPN and delete all configuration + -y, --yes assume "yes" as answer to prompts when revoking a client or removing OpenVPN + -h, --help show this help message and exit Install options (optional): - --auto auto install OpenVPN using default or custom options - --serveraddr [DNS name] server address, must be a fully qualified domain name (FQDN). - If not specified, the server's IPv4 address will be used. - --proto [TCP or UDP] protocol for OpenVPN (TCP or UDP, default: UDP) - --port [number] port for OpenVPN (1-65535, default: 1194) - --clientname [client name] name for the first OpenVPN client (default: client) - --dns1 [DNS server IP] primary DNS server for clients (default: Google Public DNS) - --dns2 [DNS server IP] secondary DNS server for clients + --auto auto install OpenVPN using default or custom options + --serveraddr [DNS name or IP] server address, must be a fully qualified domain name (FQDN) or an IPv4 address. + --proto [TCP or UDP] protocol for OpenVPN (TCP or UDP, default: UDP) + --port [number] port for OpenVPN (1-65535, default: 1194) + --clientname [client name] name for the first OpenVPN client (default: client) + --dns1 [DNS server IP] primary DNS server for clients (default: Google Public DNS) + --dns2 [DNS server IP] secondary DNS server for clients To customize options, you may also run this script without arguments. ``` diff --git a/README.md b/README.md index 8295bbf..1122e37 100644 --- a/README.md +++ b/README.md @@ -122,24 +122,23 @@ Usage: bash openvpn.sh [options] Options: - --addclient [client name] add a new client - --exportclient [client name] export configuration for an existing client - --listclients list the names of existing clients - --revokeclient [client name] revoke an existing client - --uninstall remove OpenVPN and delete all configuration - -y, --yes assume "yes" as answer to prompts when revoking a client or removing OpenVPN - -h, --help show this help message and exit + --addclient [client name] add a new client + --exportclient [client name] export configuration for an existing client + --listclients list the names of existing clients + --revokeclient [client name] revoke an existing client + --uninstall remove OpenVPN and delete all configuration + -y, --yes assume "yes" as answer to prompts when revoking a client or removing OpenVPN + -h, --help show this help message and exit Install options (optional): - --auto auto install OpenVPN using default or custom options - --serveraddr [DNS name] server address, must be a fully qualified domain name (FQDN). - If not specified, the server's IPv4 address will be used. - --proto [TCP or UDP] protocol for OpenVPN (TCP or UDP, default: UDP) - --port [number] port for OpenVPN (1-65535, default: 1194) - --clientname [client name] name for the first OpenVPN client (default: client) - --dns1 [DNS server IP] primary DNS server for clients (default: Google Public DNS) - --dns2 [DNS server IP] secondary DNS server for clients + --auto auto install OpenVPN using default or custom options + --serveraddr [DNS name or IP] server address, must be a fully qualified domain name (FQDN) or an IPv4 address. + --proto [TCP or UDP] protocol for OpenVPN (TCP or UDP, default: UDP) + --port [number] port for OpenVPN (1-65535, default: 1194) + --clientname [client name] name for the first OpenVPN client (default: client) + --dns1 [DNS server IP] primary DNS server for clients (default: Google Public DNS) + --dns2 [DNS server IP] secondary DNS server for clients To customize options, you may also run this script without arguments. ``` diff --git a/docs/clients-zh.md b/docs/clients-zh.md index 878f56c..14a7580 100644 --- a/docs/clients-zh.md +++ b/docs/clients-zh.md @@ -20,24 +20,23 @@ Usage: bash openvpn.sh [options] Options: - --addclient [client name] add a new client - --exportclient [client name] export configuration for an existing client - --listclients list the names of existing clients - --revokeclient [client name] revoke an existing client - --uninstall remove OpenVPN and delete all configuration - -y, --yes assume "yes" as answer to prompts when revoking a client or removing OpenVPN - -h, --help show this help message and exit + --addclient [client name] add a new client + --exportclient [client name] export configuration for an existing client + --listclients list the names of existing clients + --revokeclient [client name] revoke an existing client + --uninstall remove OpenVPN and delete all configuration + -y, --yes assume "yes" as answer to prompts when revoking a client or removing OpenVPN + -h, --help show this help message and exit Install options (optional): - --auto auto install OpenVPN using default or custom options - --serveraddr [DNS name] server address, must be a fully qualified domain name (FQDN). - If not specified, the server's IPv4 address will be used. - --proto [TCP or UDP] protocol for OpenVPN (TCP or UDP, default: UDP) - --port [number] port for OpenVPN (1-65535, default: 1194) - --clientname [client name] name for the first OpenVPN client (default: client) - --dns1 [DNS server IP] primary DNS server for clients (default: Google Public DNS) - --dns2 [DNS server IP] secondary DNS server for clients + --auto auto install OpenVPN using default or custom options + --serveraddr [DNS name or IP] server address, must be a fully qualified domain name (FQDN) or an IPv4 address. + --proto [TCP or UDP] protocol for OpenVPN (TCP or UDP, default: UDP) + --port [number] port for OpenVPN (1-65535, default: 1194) + --clientname [client name] name for the first OpenVPN client (default: client) + --dns1 [DNS server IP] primary DNS server for clients (default: Google Public DNS) + --dns2 [DNS server IP] secondary DNS server for clients To customize options, you may also run this script without arguments. ``` diff --git a/docs/clients.md b/docs/clients.md index 64464d1..4b27ec8 100644 --- a/docs/clients.md +++ b/docs/clients.md @@ -20,24 +20,23 @@ Usage: bash openvpn.sh [options] Options: - --addclient [client name] add a new client - --exportclient [client name] export configuration for an existing client - --listclients list the names of existing clients - --revokeclient [client name] revoke an existing client - --uninstall remove OpenVPN and delete all configuration - -y, --yes assume "yes" as answer to prompts when revoking a client or removing OpenVPN - -h, --help show this help message and exit + --addclient [client name] add a new client + --exportclient [client name] export configuration for an existing client + --listclients list the names of existing clients + --revokeclient [client name] revoke an existing client + --uninstall remove OpenVPN and delete all configuration + -y, --yes assume "yes" as answer to prompts when revoking a client or removing OpenVPN + -h, --help show this help message and exit Install options (optional): - --auto auto install OpenVPN using default or custom options - --serveraddr [DNS name] server address, must be a fully qualified domain name (FQDN). - If not specified, the server's IPv4 address will be used. - --proto [TCP or UDP] protocol for OpenVPN (TCP or UDP, default: UDP) - --port [number] port for OpenVPN (1-65535, default: 1194) - --clientname [client name] name for the first OpenVPN client (default: client) - --dns1 [DNS server IP] primary DNS server for clients (default: Google Public DNS) - --dns2 [DNS server IP] secondary DNS server for clients + --auto auto install OpenVPN using default or custom options + --serveraddr [DNS name or IP] server address, must be a fully qualified domain name (FQDN) or an IPv4 address. + --proto [TCP or UDP] protocol for OpenVPN (TCP or UDP, default: UDP) + --port [number] port for OpenVPN (1-65535, default: 1194) + --clientname [client name] name for the first OpenVPN client (default: client) + --dns1 [DNS server IP] primary DNS server for clients (default: Google Public DNS) + --dns2 [DNS server IP] secondary DNS server for clients To customize options, you may also run this script without arguments. ```