]> OzVa Git service - ozva-cloud/commitdiff
chore: update args help message and readme
authorsigoden <sigoden@gmail.com>
Sat, 25 Jun 2022 01:57:58 +0000 (09:57 +0800)
committersigoden <sigoden@gmail.com>
Sat, 25 Jun 2022 01:58:39 +0000 (09:58 +0800)
README.md
src/args.rs

index 52bb3d5add928a4ea08bbc1b8c9c1a28f5b11d53..a94146838e1d305b3e34dbde9017c90082529beb 100644 (file)
--- a/README.md
+++ b/README.md
@@ -52,7 +52,7 @@ OPTIONS:
     -b, --bind <addr>...         Specify bind address
     -p, --port <port>            Specify port to listen on [default: 5000]
         --path-prefix <path>     Specify an path prefix
-        --hidden <names>         Comma-separated list of names to hide from directory listings
+        --hidden <value>         Hide directories from directory listings, separated by `,`
     -a, --auth <rule>...         Add auth for path
         --auth-method <value>    Select auth method [default: digest] [possible values: basic, digest]
     -A, --allow-all              Allow all operations
@@ -126,7 +126,7 @@ Listen on a specific port
 dufs -p 80
 ```
 
-Hide folders from directory listing
+Hide directories from directory listings
 
 ```
 dufs --hidden .git,.DS_Store
@@ -168,23 +168,23 @@ curl -X DELETE http://127.0.0.1:5000/path-to-file
 Dufs supports path level access control. You can control who can do what on which path with `--auth`/`-a`.
 
 ```
-dufs -a <path>@<readwrite>[@<readonly>]
+dufs -a <path>@<readwrite>[@<readonly>|@*]
 ```
 
-- `<path>`: Path to protected
-- `<readwrite>`: Account with readwrite permission, required
-- `<readonly>`: Account with readonly permission, optional
+- `<path>`: Protected url path
+- `<readwrite>`: Account with upload/delete/view/download permission, required
+- `<readonly>`: Account with view/download permission, optional
 
-> `<readonly>` can be `*` means `<path>` is public, everyone can access/download it.
+> `*` means `<path>` is public, everyone can view/download it.
 
 For example:
 
 ```
 dufs -a /@admin:pass@* -a /ui@designer:pass1 -A
 ```
-- All files/folders are public to access/download.
-- Account `admin:pass` can upload/delete/download any files/folders.
-- Account `designer:pass1` can upload/delete/download any files/folders in the `ui` folder.
+- All files/folders are public to view/download.
+- Account `admin:pass` can upload/delete/view/download any files/folders.
+- Account `designer:pass1` can upload/delete/view/download any files/folders in the `ui` folder.
 
 ## License
 
index a91e00b3a3ba95519cbfb9da6bb48acc483f7cdd..f072217ee71dd6afc34d43b1561e05d9b952c630 100644 (file)
@@ -51,8 +51,8 @@ fn app() -> Command<'static> {
         .arg(
             Arg::new("hidden")
                 .long("hidden")
-                .help("Comma-separated list of names to hide from directory listings")
-                .value_name("names"),
+                .help("Hide directories from directory listings, separated by `,`")
+                .value_name("value"),
         )
         .arg(
             Arg::new("auth")