Skip to content

Docs: improve consistency #66

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
semseysandor merged 2 commits into from
Oct 7, 2023
Merged

Docs: improve consistency #66

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4742256
docs: remove <> around variables
semseysandor Oct 7, 2023
886fb1d
docs/bin: update options for backup
semseysandor Oct 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 17 additions & 17 deletions docs/bin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

---
Expand Down
8 changes: 4 additions & 4 deletions docs/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <SHELL_DIR>
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="<SHELL_DIR>/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="<SHELL_DIR>/bin:${PATH}"
PATH="SHELL_DIR/bin:${PATH}"
```

!!! tip
Expand Down