Documentation cleanup and updates

This commit is contained in:
SilasLaspada
2021-08-18 03:10:57 -06:00
parent f5598117c7
commit 4ce8487fbb
26 changed files with 203 additions and 206 deletions

View File

@@ -1,17 +1,25 @@
# Table of Contents
- [Command Description](#command-description)
- [Command usage](#command-usage)
- [Example](#example)
- [Operating system support](#operating-system-support)
## Command description
This operation will update the master database, and can optionalyl clear the master and local database.
This operation will update the master database, and can optionally clear the master and local database.
## Command usage
```aaru -d [true/false] -v [true/false] database update -h [true/false]```
```bash
Aaru -d [true/false] -v [true/false] database update -h [true/false]
```
```-d, --debug [true/false]``` shows debug output *(default false)*
```-v, --verbose [true/false]``` shows verbose output *(default false)*
```-h, --help [true/false]``` shows help screen for the command instead of running it, ignores all other switches *(
default false)*
```-h, --help [true/false]``` shows help screen for the command instead of running it, ignores all other switches*(default false)*
```--clear [true/false]``` clears existing master database before updating *(default false)*
@@ -19,7 +27,7 @@ default false)*
## Example
```aaru database update --clear-all```
```Aaru database update --clear-all```
## Operating system support