From 47422566d388e86f15102809f47749c120e1592f Mon Sep 17 00:00:00 2001 From: Sandor Semsey Date: Sat, 7 Oct 2023 23:36:50 +0200 Subject: [PATCH 1/2] docs: remove <> around variables --- docs/install.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/install.md b/docs/install.md index 00df0db..5399baf 100644 --- a/docs/install.md +++ b/docs/install.md @@ -13,17 +13,17 @@ For detailed instructions on using the loader check [Reference](lib/_loader.md). **Installation steps** -1. Clone this repo +1. Clone Git repository ``` - git clone https://github.com/es-progress/shell.git + git clone https://github.com/es-progress/shell.git SHELL_DIR ``` 1. Set `ES_SHELL_LOADER` to point to `lib/_loader.sh`. Best to put this in your `.bashrc`. ``` - export ES_SHELL_LOADER="/lib/_loader.sh" + export ES_SHELL_LOADER="SHELL_DIR/lib/_loader.sh" ``` 1. (Optional) Add `bin` to your `PATH` so you can run scripts just by name ``` - PATH="/bin:${PATH}" + PATH="SHELL_DIR/bin:${PATH}" ``` !!! tip From 886fb1d27aaf66de0ca313fed51c03354c1a03e1 Mon Sep 17 00:00:00 2001 From: Sandor Semsey Date: Sat, 7 Oct 2023 23:40:33 +0200 Subject: [PATCH 2/2] docs/bin: update options for backup --- docs/bin.md | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/docs/bin.md b/docs/bin.md index 1932661..997ca40 100644 --- a/docs/bin.md +++ b/docs/bin.md @@ -30,30 +30,30 @@ backup REQUIRED_OPTIONS... [OPTIONS]... OPTIONS REQUIRED --s, --source [DIR] source DIRECTORY to backup --d, --destination [DIR] destination DIRECTORY to put backup on +-s, --source [DIR] Source DIRECTORY to backup +-d, --destination [DIR] Destination DIRECTORY to put backup on target filesystem (relative to mounting point) --f, --filesystem [FS] target FILESYSTEM to backup to (eg. /dev/sda3) --m, --mount [DIR] mounting point for given filesystem +-f, --filesystem [FS] Target FILESYSTEM to backup to (eg. /dev/sda3) +-m, --mount [DIR] Mounting point for given filesystem OPTIONAL --a, --archive [DIR] put archives in DIR, defaults to 'archive' - --expire [NUM] deletes archives older than NUM days (NUM*24 hours) - --format [FORMAT] appends current date to archive filename - supported FORMATS: - 24H (HH:MM:SS eg. 17:26:14) - YMD (YYYY-mm-dd eg. 2020-02-19) <--default +-a, --archive [DIR] Put archives in DIR, defaults to 'archive' + --expire [NUM] Deletes archives older than NUM days (NUM*24 hours) + --format [FORMAT] Appends current date to archive filename + Supported FORMATS: + 24H (HH:MM:SS eg. 17:26:14) + YMD (YYYY-mm-dd eg. 2020-02-19) <--default FULL (YYYY-mm-dd_HH:MM:SS) - --mode [MODE] select MODE: + --mode [MODE] Select MODE: ARCHIVE: backup and create archives <--default SNAPSHOT: snapshot backup QUICK: backup only - --exclude [PATTERN] exclude files matching PATTERN - --prefix [STRING] optional prefix on archive files --q, --quiet suppress non-error messages - --debug print commands as executed --h, --help display this help --v, --version print version info + --exclude [PATTERN] Exclude files matching PATTERN + --prefix [STRING] Optional prefix on archive files +-q, --quiet Suppress non-error messages + --debug Print commands as executed +-h, --help Display this help +-v, --version Print version info ``` ---