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,24 +1,33 @@
# Table of Contents
- [Command Description](#command-description)
- [Command usage](#command-usage)
- [Example](#example)
- [Operating system support](#operating-system-support)
## Command description
This operation will show the statistics that have been stored locally on your environment.
## Command usage
```aaru -d [true/false] -v [true/false] database stats -h [true/false]```
```
Aaru -d [true/false] -v [true/false] database stats -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)*
## Example
```aaru database stats```
```Aaru database stats```
## Operating system support
| FreeBSD | macOS | Linux | Windows |
|---|---|---|---|
| Yes | Yes | Yes | Yes |
| Yes | Yes | Yes | Yes |