misc-utilities
/
mikes-backup-rotator
1
0
Fork 0
Code Issues 4 Pull Requests Releases Wiki Activity

Added an example for CLI args to the README

This commit is contained in:
Mike 2019-03-13 03:26:35 -07:00
parent 44902c2009
commit 179f6146b2
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -36,6 +36,14 @@ Tells the program to run without making any changes. Instead, it will merely lis
Specifies a path to a configuration file or directory. If a directory is specified, all files in the directory will be used as configuration files.
### Example Call With Arguments
Here's an example of how you might invoke the program with two configuration paths and set globally to a dry run:
```
python3 backup-rotator --dry-run --config "/my/config/path-1" --config "/my/config/path-1"
```
## Configuration File Format
Configuration files are written in [YAML](https://yaml.org/) format. Supported keys are as follows: