From 7d6a7ec95e3066a3f6901d889989b09fb2c6a0d5 Mon Sep 17 00:00:00 2001 From: Stuart Hayhurst Date: Sun, 14 Feb 2021 15:19:00 +0000 Subject: [PATCH] Updated argument usage, brought README and help page in sync --- README.md | 11 ++++++----- install.sh | 23 ++++++++++++----------- 2 files changed, 18 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 2b1689f..aac02de 100644 --- a/README.md +++ b/README.md @@ -12,16 +12,17 @@ Usage: `sudo ./install.sh [OPTIONS]` | -h , --help | Show a help page | | -i , --install | Install the grub theme (root) | | -u , --uninstall | Uninstall the grub theme (root) | -| -e , --boot | Install the grub theme into `/boot/grub/themes` instead | +| -e , --boot | Install the grub theme into `/boot/grub/themes` | | -p , --preview | Preview the grub theme (Works with other options, non-root) | -| -b , --background | Choose a background image (must be a .png, or bundled with the project) | +| -b , --background | Choose a background image (must be a .png, or bundled with the project)
- Leave blank to view available backgrounds| | -c , --custom | Use a solid colour as a background (HTML value, must be quoted) -| -r , --resolution | Select the display resolution | -| -fc, --fontcolour | Use a specific font colour (HTML (must be quoted) and SVG 1.0 colours supported)
Use the format: -fc "textcolour,selectedcolour" | +| -r , --resolution | Select the display resolution
- Leave blank to view available resolutions | +| -f , --font | Specify which font to use (file)
- Leave blank to view available fonts | +| -fc, --fontcolour | Use a specific font colour (HTML (must be quoted) and SVG 1.0 colours supported)
- Use the format: -fc "textcolour,selectedcolour" | | -fs, --fontsize | Use a specific font size | -| -f , --font | Use a specific font | | -l , --bold | Force font to be bold | | -hl, --help-label | Add a help label to the bottom of the theme | + Required arguments: [--install + --background / --uninstall / --preview] ## Examples: diff --git a/install.sh b/install.sh index 103b455..1cb2882 100755 --- a/install.sh +++ b/install.sh @@ -460,21 +460,22 @@ while [[ $i -le "$(($# - 1))" ]]; do -h|--help) output "normal" "Usage: ./install.sh [-OPTION]"; output "normal" "Help:" output "normal" "-h | --help : Display this page" - output "normal" "-i | --install : Install the theme" - output "normal" "-u | --uninstall : Uninstall the theme" - output "normal" "-e | --boot : Install the theme to '/boot/grub/themes'" - output "normal" "-p | --preview : Preview the theme (Works with other options)" - output "normal" "-b | --background : Specify which background to use" - output "normal" " - Leave blank to view available backgrounds" - output "normal" "-c | --custom : Specify which background to use" - output "normal" " - Leave blank to view available backgrounds" + output "normal" "-i | --install : Install the theme (root)" + output "normal" "-u | --uninstall : Uninstall the theme (root)" + output "normal" "-e | --boot : Install the theme into '/boot/grub/themes'" + output "normal" "-p | --preview : Preview the theme (Works with other options, non-root)" + output "normal" "-b | --background : Specify which background to use (file)" + output "normal" " - Leave blank to view available backgrounds" + output "normal" "-c | --custom : Use a solid colour as a background" + output "normal" " - HTML colour value, must be quoted (\"#FFFFFF\")" output "normal" "-r | --resolution : Use a specific resolution (Default: 1080p)" output "normal" " - Leave blank to view available resolutions" + output "normal" "-f | --font : Specify which font to use (file)" + output "normal" " - Leave blank to view available fonts" output "normal" "-fc| --fontcolour : Use a specific font colour" - output "normal" " - HTML (must be quoted) and SVG 1.0 colours supported" - output "normal" " - Use the format: \"textcolour,selectedcolour\"" + output "normal" " - HTML (must be quoted) and SVG 1.0 colours supported" + output "normal" " - Use the format: -fc \"textcolour,selectedcolour\"" output "normal" "-fs| --fontsize : Use a specific font size" - output "normal" "-f | --font : Use a specific font" output "normal" "-l | --bold : Force font to be bold" output "normal" "-hl| --help-label : Add a help label to the bottom of the theme" output "normal" "\nRequired arguments: [--install + --background / --uninstall / --preview]"