mirrors/rustic
2
0
Fork 0
mirror of https://github.com/rustic-rs/rustic.git synced 2025-10-26 11:18:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix(docs/cli): improve the descriptions of the CLI commands (#1277)

Browse Source 
Fixed the capitalization of `dump` for the dump command, and then
figured, that there might be some better descriptions for other commands
as well.

---------

Signed-off-by: simonsan <14062932+simonsan@users.noreply.github.com>
This commit is contained in:
simonsan 2024-10-02 15:45:43 +02:00 committed by GitHub
parent ec6165a25e
commit 238ae99450
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 10 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
src/commands.rs
View File

@ -78,7 +78,7 @@ enum RusticCmd {
/// Backup to the repository
Backup(BackupCmd),
/// Show raw data of repository files and blobs
/// Show raw data of files and blobs in a repository
Cat(CatCmd),
/// Change the repository configuration
@ -90,20 +90,19 @@ enum RusticCmd {
/// Check the repository
Check(CheckCmd),
/// Copy snapshots to other repositories. Note: The target repositories must be given in the config file!
/// Copy snapshots to other repositories
Copy(CopyCmd),
/// Compare two snapshots/paths
/// Note that the exclude options only apply for comparison with a local path
/// Compare two snapshots or paths
Diff(DiffCmd),
/// Open the documentation
Docs(DocsCmd),
/// dump the contents of a file in a snapshot to stdout
/// Dump the contents of a file within a snapshot to stdout
Dump(DumpCmd),
/// Find in given snapshots
/// Find patterns in given snapshots
Find(FindCmd),
/// Remove snapshots from the repository
@ -112,10 +111,10 @@ enum RusticCmd {
/// Initialize a new repository
Init(InitCmd),
/// Manage keys
/// Manage keys for a repository
Key(KeyCmd),
/// List repository files
/// List repository files by file type
List(ListCmd),
/// List file contents of a snapshot
@ -130,17 +129,17 @@ enum RusticCmd {
/// Show the configuration which has been read from the config file(s)
ShowConfig(ShowConfigCmd),
/// Update to the latest rustic release
/// Update to the latest stable rustic release
#[cfg_attr(not(feature = "self-update"), clap(hide = true))]
SelfUpdate(SelfUpdateCmd),
/// Remove unused data or repack repository pack files
Prune(PruneCmd),
/// Restore a snapshot/path
/// Restore (a path within) a snapshot
Restore(RestoreCmd),
/// Repair a snapshot/path
/// Repair a snapshot or the repository index
Repair(RepairCmd),
/// Show general information about the repository