From ee782d904fefc08b96a90a38b4e709b672a308b1 Mon Sep 17 00:00:00 2001 From: Matthew Lopez <73856503+MatthewL246@users.noreply.github.com> Date: Wed, 5 Jun 2024 17:31:28 -0400 Subject: [PATCH] docs: fix incorrect short command-line arguments --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 70c66c1..0430487 100644 --- a/README.md +++ b/README.md @@ -48,16 +48,16 @@ This script can also be run in a Docker container. This script can be configured using environment variables, a `.env` file, or individual command-line arguments. Alternatively, it can be run with the `-i` or `--interactive` flag to interactively prompt for all configuration values. Command-line arguments always override environment variables. -| Environment Variable | Command-line Argument | Description | Default | -| -------------------------- | --------------------------------------- | ------------------------------------------------------------------- | ----------------------------- | -| N/A | `-i`, `--interactive` | Interactively prompt for all configuration values | N/A | -| SSSL_NINTENDO_CA_G3_PATH | `-g`, `--nintendo-ca-g3-path ` | Path to Nintendo CA - G3 certificate (may be in DER or PEM format) | `./CACERT_NINTENDO_CA_G3.der` | -| SSSL_NINTENDO_CA_G3_FORMAT | `-f`, `--nintendo-ca-g3-format ` | Nintendo CA - G3 certificate format (must be "der" or "pem") | `der` | -| SSSL_CA_PRIVATE_KEY_PATH | `-c`, `--ca-private-key-path ` | Path to private key for forged CA (will generate if not set) | N/A | -| SSSL_SITE_PRIVATE_KEY_PATH | `-s`, `--site-private-key-path ` | Path to private key for site certificate (will generate if not set) | N/A | -| SSSL_CSR_PATH | `-r`, `--csr-path ` | Path to CSR (will generate if not set) | N/A | -| SSSL_COMMON_NAME | `-n`, `--common-name ` | CN for site certificate (see [the bugs](#the-bugs)) | `*` | -| SSSL_OUTPUT_FOLDER_PATH | `-o`, `--output-folder-path ` | Output folder | `./` | +| Environment Variable | Command-line Argument | Description | Default | +| -------------------------- | ---------------------------------------- | ------------------------------------------------------------------- | ----------------------------- | +| N/A | `-i`, `--interactive` | Interactively prompt for all configuration values | N/A | +| SSSL_NINTENDO_CA_G3_PATH | `-g3`, `--nintendo-ca-g3-path ` | Path to Nintendo CA - G3 certificate (may be in DER or PEM format) | `./CACERT_NINTENDO_CA_G3.der` | +| SSSL_NINTENDO_CA_G3_FORMAT | `-f`, `--nintendo-ca-g3-format ` | Nintendo CA - G3 certificate format (must be "der" or "pem") | `der` | +| SSSL_CA_PRIVATE_KEY_PATH | `-cap`, `--ca-private-key-path ` | Path to private key for forged CA (will generate if not set) | N/A | +| SSSL_SITE_PRIVATE_KEY_PATH | `-sp`, `--site-private-key-path ` | Path to private key for site certificate (will generate if not set) | N/A | +| SSSL_CSR_PATH | `-csrp`, `--csr-path ` | Path to CSR (will generate if not set) | N/A | +| SSSL_COMMON_NAME | `-cn`, `--common-name ` | CN for site certificate (see [the bugs](#the-bugs)) | `*` | +| SSSL_OUTPUT_FOLDER_PATH | `-o`, `--output-folder-path ` | Output folder | `./` | ## Credits