larryh/corso
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Docs Auto-Generation (#1008)

Browse Source 
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action
This commit is contained in:
github-actions[bot] 2022-09-30 22:40:59 +00:00 committed by GitHub
parent b612718723
commit 5e4b823663
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 19 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/docs/cli/corso_backup_create_exchange.md
View File

@ -15,9 +15,9 @@ corso backup create exchange [flags]
|Flag|Short|Default|Help| |Flag|Short|Default|Help|
|:----|:-----|:-------|:----| |:----|:-----|:-------|:----|
|`--all`||`false`|Backup all Exchange data for all users| |`--all`||`false`|Backup all Exchange data for all users|
|`--user`||`[]`|Backup Exchange data by user ID; accepts * to select all users|
|`--data`||`[]`|Select one or more types of data to backup: email, contacts, or events| |`--data`||`[]`|Select one or more types of data to backup: email, contacts, or events|
|`--help`|`-h`|`false`|help for exchange| |`--help`|`-h`|`false`|help for exchange|
|`--user`||`[]`|Backup Exchange data by user ID; accepts * to select all users|
### Global and inherited flags ### Global and inherited flags

2
docs/docs/cli/corso_backup_create_onedrive.md
View File

@ -14,8 +14,8 @@ corso backup create onedrive [flags]
|Flag|Short|Default|Help| |Flag|Short|Default|Help|
|:----|:-----|:-------|:----| |:----|:-----|:-------|:----|
|`--help`|`-h`|`false`|help for onedrive|
|`--user`||`[]`|Backup OneDrive data by user ID; accepts * to select all users| |`--user`||`[]`|Backup OneDrive data by user ID; accepts * to select all users|
|`--help`|`-h`|`false`|help for onedrive|
### Global and inherited flags ### Global and inherited flags

14
docs/docs/cli/corso_backup_details_exchange.md
View File

@ -15,24 +15,24 @@ corso backup details exchange [flags]
|Flag|Short|Default|Help| |Flag|Short|Default|Help|
|:----|:-----|:-------|:----| |:----|:-----|:-------|:----|
|`--backup`|||ID of the backup containing the details to be shown| |`--backup`|||ID of the backup containing the details to be shown|
|`--contact`||`[]`|Select backup details by contact ID; accepts * to select all contacts| |`--user`||`[]`|Select backup details by user ID; accepts * to select all users|
|`--contact-folder`||`[]`|Select backup details by contact folder ID; accepts * to select all contact folders|
|`--contact-name`|||Select backup details where the contact name contains this value|
|`--email`||`[]`|Select backup details by emails ID; accepts * to select all emails| |`--email`||`[]`|Select backup details by emails ID; accepts * to select all emails|
|`--email-folder`||`[]`|Select backup details by email folder ID; accepts * to select all email folders| |`--email-folder`||`[]`|Select backup details by email folder ID; accepts * to select all email folders|
|`--email-subject`|||Restore mail where the email subject lines contain this value|
|`--email-sender`|||Restore mail where the email sender matches this user id|
|`--email-received-after`|||Restore mail where the email was received after this datetime| |`--email-received-after`|||Restore mail where the email was received after this datetime|
|`--email-received-before`|||Restore mail where the email was received before this datetime| |`--email-received-before`|||Restore mail where the email was received before this datetime|
|`--email-sender`|||Restore mail where the email sender matches this user id|
|`--email-subject`|||Restore mail where the email subject lines contain this value|
|`--event`||`[]`|Select backup details by event ID; accepts * to select all events| |`--event`||`[]`|Select backup details by event ID; accepts * to select all events|
|`--event-calendar`||`[]`|Select backup details by event calendar ID; accepts * to select all events| |`--event-calendar`||`[]`|Select backup details by event calendar ID; accepts * to select all events|
|`--event-subject`|||Select backup details where the event subject contains this value|
|`--event-organizer`|||Select backup details where the event organizer user id contains this value| |`--event-organizer`|||Select backup details where the event organizer user id contains this value|
|`--event-recurs`|||Select backup details if the event recurs. Use `--event-recurs` false to select non-recurring events| |`--event-recurs`|||Select backup details if the event recurs. Use `--event-recurs` false to select non-recurring events|
|`--event-starts-after`|||Select backup details where the event starts after this datetime| |`--event-starts-after`|||Select backup details where the event starts after this datetime|
|`--event-starts-before`|||Select backup details where the event starts before this datetime| |`--event-starts-before`|||Select backup details where the event starts before this datetime|
|`--event-subject`|||Select backup details where the event subject contains this value| |`--contact`||`[]`|Select backup details by contact ID; accepts * to select all contacts|
|`--contact-folder`||`[]`|Select backup details by contact folder ID; accepts * to select all contact folders|
|`--contact-name`|||Select backup details where the contact name contains this value|
|`--help`|`-h`|`false`|help for exchange| |`--help`|`-h`|`false`|help for exchange|
|`--user`||`[]`|Select backup details by user ID; accepts * to select all users|
### Global and inherited flags ### Global and inherited flags

2
docs/docs/cli/corso_repo_connect_s3.md
View File

@ -15,9 +15,9 @@ corso repo connect s3 [flags]
|Flag|Short|Default|Help| |Flag|Short|Default|Help|
|:----|:-----|:-------|:----| |:----|:-----|:-------|:----|
|`--bucket`|||Name of the S3 bucket (required).| |`--bucket`|||Name of the S3 bucket (required).|
|`--prefix`|||Prefix applied to objects in the bucket.|
|`--endpoint`||`s3.amazonaws.com`|Server endpoint for S3 communication.| |`--endpoint`||`s3.amazonaws.com`|Server endpoint for S3 communication.|
|`--help`|`-h`|`false`|help for s3| |`--help`|`-h`|`false`|help for s3|
|`--prefix`|||Prefix applied to objects in the bucket.|
### Global and inherited flags ### Global and inherited flags

2
docs/docs/cli/corso_repo_init_s3.md
View File

@ -15,9 +15,9 @@ corso repo init s3 [flags]
|Flag|Short|Default|Help| |Flag|Short|Default|Help|
|:----|:-----|:-------|:----| |:----|:-----|:-------|:----|
|`--bucket`|||Name of the S3 bucket (required).| |`--bucket`|||Name of the S3 bucket (required).|
|`--prefix`|||Prefix applied to objects in the bucket.|
|`--endpoint`||`s3.amazonaws.com`|Server endpoint for S3 communication.| |`--endpoint`||`s3.amazonaws.com`|Server endpoint for S3 communication.|
|`--help`|`-h`|`false`|help for s3| |`--help`|`-h`|`false`|help for s3|
|`--prefix`|||Prefix applied to objects in the bucket.|
### Global and inherited flags ### Global and inherited flags

14
docs/docs/cli/corso_restore_exchange.md
View File

@ -15,24 +15,24 @@ corso restore exchange [flags]
|Flag|Short|Default|Help| |Flag|Short|Default|Help|
|:----|:-----|:-------|:----| |:----|:-----|:-------|:----|
|`--backup`|||ID of the backup to restore| |`--backup`|||ID of the backup to restore|
|`--contact`||`[]`|Restore contacts by ID; accepts * to select all contacts| |`--user`||`[]`|Restore all data by user ID; accepts * to select all users|
|`--contact-folder`||`[]`|Restore all contacts within the folder ID; accepts * to select all contact folders|
|`--contact-name`|||Restore contacts where the contact name contains this value|
|`--email`||`[]`|Restore emails by ID; accepts * to select all emails| |`--email`||`[]`|Restore emails by ID; accepts * to select all emails|
|`--email-folder`||`[]`|Restore all emails by folder ID; accepts * to select all email folders| |`--email-folder`||`[]`|Restore all emails by folder ID; accepts * to select all email folders|
|`--email-subject`|||Restore mail where the email subject lines contain this value|
|`--email-sender`|||Restore mail where the email sender matches this user id|
|`--email-received-after`|||Restore mail where the email was received after this datetime| |`--email-received-after`|||Restore mail where the email was received after this datetime|
|`--email-received-before`|||Restore mail where the email was received before this datetime| |`--email-received-before`|||Restore mail where the email was received before this datetime|
|`--email-sender`|||Restore mail where the email sender matches this user id|
|`--email-subject`|||Restore mail where the email subject lines contain this value|
|`--event`||`[]`|Restore events by ID; accepts * to select all events| |`--event`||`[]`|Restore events by ID; accepts * to select all events|
|`--event-calendar`||`[]`|Restore events by calendar ID; accepts * to select all event calendars| |`--event-calendar`||`[]`|Restore events by calendar ID; accepts * to select all event calendars|
|`--event-subject`|||Restore events where the event subject contains this value|
|`--event-organizer`|||Restore events where the event organizer user id contains this value| |`--event-organizer`|||Restore events where the event organizer user id contains this value|
|`--event-recurs`|||Restore events if the event recurs. Use `--event-recurs false` to select non-recurring events| |`--event-recurs`|||Restore events if the event recurs. Use `--event-recurs false` to select non-recurring events|
|`--event-starts-after`|||Restore events where the event starts after this datetime| |`--event-starts-after`|||Restore events where the event starts after this datetime|
|`--event-starts-before`|||Restore events where the event starts before this datetime| |`--event-starts-before`|||Restore events where the event starts before this datetime|
|`--event-subject`|||Restore events where the event subject contains this value| |`--contact`||`[]`|Restore contacts by ID; accepts * to select all contacts|
|`--contact-folder`||`[]`|Restore all contacts within the folder ID; accepts * to select all contact folders|
|`--contact-name`|||Restore contacts where the contact name contains this value|
|`--help`|`-h`|`false`|help for exchange| |`--help`|`-h`|`false`|help for exchange|
|`--user`||`[]`|Restore all data by user ID; accepts * to select all users|
### Global and inherited flags ### Global and inherited flags

2
docs/docs/cli/corso_restore_onedrive.md
View File

@ -15,8 +15,8 @@ corso restore onedrive [flags]
|Flag|Short|Default|Help| |Flag|Short|Default|Help|
|:----|:-----|:-------|:----| |:----|:-----|:-------|:----|
|`--backup`|||ID of the backup to restore| |`--backup`|||ID of the backup to restore|
|`--help`|`-h`|`false`|help for onedrive|
|`--user`||`[]`|Restore all data by user ID; accepts * to select all users| |`--user`||`[]`|Restore all data by user ID; accepts * to select all users|
|`--help`|`-h`|`false`|help for onedrive|
### Global and inherited flags ### Global and inherited flags