change some cmd doc style

yangsen · yangsen · commit 079b3e6ddcb4 · 2023-01-10T16:12:41.000+08:00
diff --git a/docs/batchstat.md b/docs/batchstat.md
@@ -37,7 +37,7 @@ $ qshell batchstat --doc
 - --record-redo-while-error：依赖于 --enable-record；命令重新执行时，命令中所有任务会从头到尾重新执行；每个任务执行前会根据记录先查看当前任务是否已经执行，如果任务已执行且失败，则再执行一次；默认为 false，当任务执行失败则跳过不再重新执行。 【可选】
 
 # 示例
-- 我们将查询空间`7qiniu`中的一些文件的基本信息，待查询文件列表`listFile` 的内容为：
+- 我们将查询空间 `7qiniu` 中的一些文件的基本信息，待查询文件列表 `listFile` 的内容为：
 ```
 RclviFDHaQAUl3aL46jKRskUWbg=/FpwH76F3yfYmFKoPDjoSNWzeLKYp/000000.ts
 RclviFDHaQAUl3aL46jKRskUWbg=/FpwH76F3yfYmFKoPDjoSNWzeLKYp/000001.ts
@@ -53,7 +53,7 @@ RclviFDHaQAUl3aL46jKRskUWbg=/FpwH76F3yfYmFKoPDjoSNWzeLKYp/000005.ts
 $ qshell batchstat 7qiniu -i listFile
 ```
 
-- 输出 Key、Fsize、Hash、MimeType、PutTime 以`\t`分隔：
+- 输出 Key、Fsize、Hash、MimeType、PutTime 以 `\t` 分隔：
 ```
 RclviFDHaQAUl3aL46jKRskUWbg=/FpwH76F3yfYmFKoPDjoSNWzeLKYp/000000.ts 92308   Fk8Uf2SHbQ4S2-cXHINuRc_rooNA    video/mp2t  15003760414606314
 RclviFDHaQAUl3aL46jKRskUWbg=/FpwH76F3yfYmFKoPDjoSNWzeLKYp/000001.ts 91556   FpJP2nfipuLVc6QGvvcb868Rd0pO    video/mp2t  15003760414789673
@@ -64,4 +64,4 @@ RclviFDHaQAUl3aL46jKRskUWbg=/FpwH76F3yfYmFKoPDjoSNWzeLKYp/000005.ts 92120   Fh4F
 ```
 
 # 注意
-如果没有指定输入文件， 默认从标准输入读取内容
+如果没有指定输入文件， 默认从标准输入读取内容。
diff --git a/docs/buckets.md b/docs/buckets.md
@@ -23,7 +23,7 @@ $ qshell buckets --doc
 无参数。
 
 # 选项
-- --region：指定需要列举 bucket 所在的区域。
+- --region：指定需要列举所在区域的 bucket。
 - --detail：打印 bucket 详情，如果无此选项则仅列举 bucket 名称，增加此选项后可依次展示 bucket 名、bucket 所在区域、bucket 文件数量、bucket 占用空间大小。
 
 # 示例
diff --git a/docs/cdnprefetch.md b/docs/cdnprefetch.md
@@ -1,5 +1,5 @@
 # 简介
-`cdnprefetch` 命令用来根据指定的文件访问列表来批量预取CDN的访问外链。
+`cdnprefetch` 命令用来根据指定的文件访问列表来批量预取 CDN 的访问外链。
 
 # 格式
 ```
@@ -47,4 +47,4 @@ http://if-pbl.qiniudn.com/hello7.txt
 $ qshell cdnprefetch -i toprefetch.txt
 ```
 
-就可以预取文件`toprefetch.txt`中的访问外链了。
+就可以预取文件 `toprefetch.txt` 中的访问外链了。
diff --git a/docs/cdnrefresh.md b/docs/cdnrefresh.md
@@ -1,5 +1,5 @@
 # 简介
-`cdnrefresh` 命令用来根据指定的文件访问列表或者目录列表来批量更新CDN的缓存。
+`cdnrefresh` 命令用来根据指定的文件访问列表或者目录列表来批量更新 CDN 的缓存。
 
 # 格式
 刷新链接的命令格式：
diff --git a/docs/chgm.md b/docs/chgm.md
@@ -1,5 +1,5 @@
 # 简介
-`chgm` 指令用来为空间中的一个文件修改MimeType。
+`chgm` 指令用来为空间中的一个文件修改 MimeType。
 
 参考文档：[资源元信息修改 (chgm)](http://developer.qiniu.com/code/v6/api/kodo-api/rs/chgm.html)
 
@@ -32,7 +32,7 @@ $ qshell chgm --doc
 $ qshell chgm if-pbl qiniu.png image/jpeg
 ```
 
-修改完成，我们检查一下文件的MimeType：
+修改完成，我们检查一下文件的 MimeType：
 ```
 $ qshell stat if-pbl qiniu.png
 ```
@@ -46,4 +46,4 @@ Fsize:              5331
 PutTime:            14285516077733591
 MimeType:           image/jpeg
 ```
-我们发现，文件的MimeType已经被修改为 `image/jpeg`。
+我们发现，文件的 MimeType 已经被修改为 `image/jpeg`。
diff --git a/docs/chtype.md b/docs/chtype.md
@@ -25,7 +25,7 @@ $ qshell chtype --doc
 - FileType：给文件指定的新的存储类型，其中可选值为 `0` 代表 `普通存储`，`1` 代表 `低频存储`，`2` 代表 `归档存储`，`3` 代表 `深度归档存储`。【必选】
 
 注：
-`归档存储` 直接转 `普通存储` 或 `低频存储` 会失败，需要通过再存储的方式。
+`归档存储` 直接转 `普通存储` 或 `低频存储` 会失败，需要先通过 restorear 命令恢复后再转。
 
 # 示例
 修改 `if-pbl` 空间中 `qiniu.png` 图片的存储类型为 `低频存储`
diff --git a/docs/copy.md b/docs/copy.md
@@ -1,6 +1,9 @@
 # 简介
 `copy` 命令用来为存储在七牛空间中的文件创建副本。注意如果目标文件已存在空间中的时候，默认情况下，`copy` 会失败，报错 `614 file exists`，如果一定要强制覆盖目标文件，可以使用选项 `--overwrite` 。
 
+注：
+原空间和目标空间必须属于同一个区域。
+
 参考文档：[资源复制 (copy)](http://developer.qiniu.com/code/v6/api/kodo-api/rs/copy.html)
 
 # 格式
diff --git a/docs/domains.md b/docs/domains.md
@@ -26,7 +26,7 @@ $ qshell domains --doc
 --detail：展示域名的详细信息，默认只展示域名的名称。【可选】
 
 # 示例
-获取空间 `if-pbl` 对应的所有的域名：
+获取空间 `if-pbl` 对应的所有域名：
 ```
 $ qshell domains if-pbl
 ```
diff --git a/docs/expire.md b/docs/expire.md
@@ -30,4 +30,4 @@ $ qshell expire --doc
 ```
 $ qshell chtype if-pbl qiniu.png 3
 ```
-输入该命令，后该文件就已经被修改为3天后自动删除了
+输入该命令，后该文件就已经被修改为 3 天后自动删除了。
diff --git a/docs/fetch.md b/docs/fetch.md
@@ -1,6 +1,6 @@
 # 简介
 `fetch` 指令根据七牛的公开API [fetch](http://developer.qiniu.com/code/v6/api/kodo-api/rs/fetch.html) 来从互联网上抓取一个资源并保存到七牛的空间中。 
-每次抓取的资源，如果指定的Key都是一样的，那么会默认覆盖这个Key所对应的文件。
+每次抓取的资源，如果指定的 Key 都是一样的，那么会默认覆盖这个 Key 所对应的文件。
 
 参考文档：[第三方资源抓取 (fetch)](http://developer.qiniu.com/code/v6/api/kodo-api/rs/fetch.html)
 
diff --git a/docs/fput.md b/docs/fput.md
@@ -1,5 +1,5 @@
 # 简介
-`fput` 命令用来以 `multipart/form-data` 的表单方式上传一个文件。适合于中小型文件的上传，一般建议如果文件大小超过100MB的话，都使用分片上传。
+`fput` 命令用来以 `multipart/form-data` 的表单方式上传一个文件。适合于中小型文件的上传，一般建议如果文件大小超过 100MB 的话，都使用分片上传。
 
 参考文档：[直传文件 (upload)](http://developer.qiniu.com/code/v6/api/kodo-api/up/upload.html)
 
diff --git a/docs/func.md b/docs/func.md
@@ -1,5 +1,5 @@
 # 简介
-`func` 命令是封装 Go 语言的模板功能，你可已使用此命令进行模板的相关处理。
+`func` 命令是封装 Go 语言的模板功能，你可以使用此命令进行模板相关的处理。
 
 具体参考：
 https://pkg.go.dev/text/template
diff --git a/docs/get.md b/docs/get.md
@@ -1,5 +1,5 @@
 # 简介
-`get` 用来从存储空间下载指定文件
+`get` 用来从存储空间下载指定的文件。
 
 # 格式
 ```
@@ -35,13 +35,13 @@ $ qshell get --doc
 - --remove-temp-while-error: 当下载遇到错误时删除之前下载的部分文件缓存，默认为 `false` (不删除)【可选】
 
 # 示例
-1 把qiniutest空间下的文件test.txt下载到本地， 当前目录
+1 把 `qiniutest` 空间下的文件 test.txt 下载到本地的当前目录：
 ```
 $ qshell get qiniutest test.txt
 ```
-下载完成后，在本地当前目录可以看到文件test.txt
+下载完成后，在本地当前目录可以看到文件 test.txt
 
-2 把 `qiniutest` 空间下的文件 `test.txt` 下载到本地，以路径 `/Users/caijiaqiang/hah.txt` 保存。
+2 把 `qiniutest` 空间下的文件 `test.txt` 下载到本地，以路径 `/Users/caijiaqiang/hah.txt` 进行保存。
 ```
 $ qshell get qiniutest test.txt -o /Users/caijiaqiang/hah.txt
 ```
diff --git a/docs/ip.md b/docs/ip.md
@@ -1,7 +1,7 @@
 # 简介
-`ip` 是一个查询ip归属地和运营商的工具，根据淘宝的API来获取结果。
+`ip` 是一个查询 ip 归属地和运营商的工具，根据淘宝的 API 来获取结果。
 
-API 地址：[http://ip.taobao.com/service/getIpInfo.php](http://ip.taobao.com/service/getIpInfo.php) 。该工具一次可以查询多个ip的信息。
+API 地址：[http://ip.taobao.com/service/getIpInfo.php](http://ip.taobao.com/service/getIpInfo.php) 。该工具一次可以查询多个 ip 的信息。
 
 # 格式
 ```
diff --git a/docs/listbucket2.md b/docs/listbucket2.md
@@ -83,7 +83,7 @@ qshell listbucket2 [--prefix <Prefix>] <Bucket> -o <ListBucketResultFile>
  ```
  qshell listbucket2 --start 2018-10-30 --end 2018-11-03 <Bucket>
  ```
-注意startDate 和 endDate 是这种半开半闭区间[startDate, endDate)
+注意 startDate 和 endDate 是这种半开半闭区间[startDate, endDate)
 
 7 获取后缀为 mp4, html 的文件
  ```
diff --git a/docs/move.md b/docs/move.md
@@ -1,5 +1,5 @@
 # 简介
-`move` 命令可以将一个空间中的文件移动到另外一个空间中，也可以对同一空间中的文件重命名。注意：移动文件仅支持在同一个帐号下面的空间中移动。
+`move` 命令可以将一个空间中的文件移动到另外一个空间中，也可以对同一空间中的文件重命名。移动文件仅支持在同一个帐号下面的同区域空间中移动。
 注意如果目标文件已存在空间中的时候，默认情况下，`move` 会失败，报错 `614 file exists`，如果一定要强制覆盖目标文件，可以使用选项 `--overwrite` 。
 
 参考文档：[资源移动／重命名 (move)](http://developer.qiniu.com/code/v6/api/kodo-api/rs/move.html)
diff --git a/docs/pfop.md b/docs/pfop.md
@@ -1,5 +1,5 @@
 # 简介
-`pfop` 用来提交异步处理音视频请求， 比如视频转码，水印等， 打印服务端返回的`PersistentID` 到标准输出上（终端）， 可以根据该 `PersistentID` 查询处理进度
+`pfop` 用来提交异步处理音视频请求， 比如视频转码，水印等， 打印服务端返回的 `PersistentID` 到标准输出上（终端）， 可以根据该 `PersistentID` 查询处理进度
 
 参考文档：[pfop请求](http://developer.qiniu.com/code/v6/api/dora-api/pfop/pfop.html)
 
@@ -30,7 +30,7 @@ $ qshell pfop --doc
 - -f/--force：强制执行数据处理。当服务端发现 fops 指定的数据处理结果已经存在，那就认为已经处理成功，避免重复处理浪费资源。 增加此选项（--force），则可强制执行数据处理并覆盖原结果。【可选】
 
 # 示例
-1 把qiniutest空间下的文件 `test.avi` 转码成 `mp4文件`, 转码后的结果保存到`qiniutest` 空间中
+1 把 qiniutest 空间下的文件 `test.avi` 转码成 `mp4` 文件，转码后的结果保存到 `qiniutest` 空间中
 ```
 $ qshell pfop qiniutest test.avi 'avthumb/mp4'
 ```
diff --git a/docs/privateurl.md b/docs/privateurl.md
@@ -1,5 +1,5 @@
 # 简介
-七牛空间分为公开空间和私有空间，无论是公开空间还是私有空间都对应一个默认的七牛的域名，这个域名也可以是用户自己的子域名。对于公开空间的资源访问，可以直接通过拼接域名和文件名的方式访问，而对私有空间中的资源，则还需要额外的授权操作。`privateurl` 命令用来快速生成带签名的私有资源外链。 
+`privateurl` 命令用来快速生成带签名的私有资源外链。七牛空间分为公开空间和私有空间，无论是公开空间还是私有空间都对应一个默认的七牛的域名，这个域名也可以是用户自己的子域名。对于公开空间的资源访问，可以直接通过拼接域名和文件名的方式访问，而对私有空间中的资源，则还需要额外的授权操作。 
 
 # 格式
 ```
diff --git a/docs/qdownload.md b/docs/qdownload.md
@@ -7,7 +7,7 @@
 
 ### 注：【该功能默认需要计费，如果希望享受 10G 的免费流量，请自行设置 cdn_domain 参数，如不设置，需支付源站流量费用，无法减免！！！】
 
-本工具批量下载文件支持多文件并发下载，另外还支持单个文件的断点续传。除此之外，也可以支持指定前缀或者后缀的文件同步，注意这里的前缀只能指定一个，但是后缀可以指定多个，多个后缀直接使用英文的逗号(,)分隔。
+本工具批量下载文件支持多文件并发下载，另外还支持单个文件的断点下载。除此之外，也可以支持指定前缀或者后缀的文件同步，注意这里的前缀只能指定一个，但是后缀可以指定多个，多个后缀直接使用英文的逗号(,)分隔。
 
 # 格式
 ```
@@ -33,7 +33,7 @@ $ qshell qdownload --doc
 其中 `ThreadCount` 表示支持同时下载多个文件。
 
 # 选项
-- -c/--thread：配置下载的并发协程数量，表示支持同时下载多个文件（ThreadCount）, 大小必须在1-2000，如果不在这个范围内，默认为5。
+- -c/--thread：配置下载的并发协程数量，表示支持同时下载多个文件（ThreadCount）, 大小必须在 1~2000，如果不在这个范围内，默认为 5。
 - -s/--success-list：指定一个文件名字，导入下载成功的文件列表到该文件。
 - -f/--failure-list：指定一个文件名字， 导入下砸失败的文件列表到该文件。
 
@@ -82,16 +82,15 @@ $ qshell qdownload --doc
 - record_root：下载记录信息保存路径，包括日志文件和下载进度文件；默认为 `qshell` 下载目录；【可选】
     - 通过 `-L` 指定工作目录时，`record_root` 则为 `此工作目录/qupload/$jobId`，
     - 未通过 `-L` 指定工作目录时为 `用户目录/.qshell/users/$CurrentUserName/qupload/$jobId`
-    - 注意 `jobId` 是根据上传任务动态生成；具体方式为 MD5("DestDir:$Bucket:KeyFile")；`CurrentUserName` 当前用户的名称
+    - 注意 `jobId` 是根据上传任务动态生成；具体方式为 MD5("DestDir:$Bucket:$KeyFile")；`CurrentUserName` 当前用户的名称
 
 ##### 备注：
-1. 在Windows系统下面使用的时候，注意 `dest_dir` 的设置遵循 `D:\\jemy\\backup` 这种方式。也就是路径里面的 `\` 要有两个（`\\`）。
+1. 在 Windows 系统下面使用的时候，注意 `dest_dir` 的设置遵循 `D:\\jemy\\backup` 这种方式。也就是路径里面的 `\` 要有两个（`\\`）。
 2. 在默认不指定 `cdn_domain` 的情况下，会从存储源站下载资源，这部分下载产生的流量会生成存储源站下载流量的计费，请注意，这部分计费不在七牛 CDN 免费 10G 流量覆盖范围。
 
 # 示例
 需要同步空间 `qdisk` 中的所有以 `movies/` 开头(理解为前缀的概念，那么 `movies/1.mp4`, `movies/2.mp4` 等以 `movies/` 为前缀的文件都会被下载保存)，并以 `.mp4`
-结尾的文件到本地路径 `/Users/jemy/Temp7/backup` 下面（把下面的配置内容写入配置文件 `qdisk_down.conf`，该配置文件需要自行创建）：
-
+结尾的文件到本地路径 `/Users/jemy/Temp7/backup` 下面；把下面的配置内容写入配置文件 `qdisk_down.conf`，该配置文件需要自行创建：
 ```
 {
 	"dest_dir"	:	"/Users/jemy/Temp7/backup",
@@ -104,7 +103,6 @@ $ qshell qdownload --doc
 ```
 
 运行命令（下载并发数表示可以同时下载 10 个文件）：
-
 ```
 qshell qdownload -c 10 qdisk_down.conf
 ```
diff --git a/docs/qetag.md b/docs/qetag.md
@@ -1,5 +1,5 @@
 # 简介
-`qtag` 算法是七牛用来计算文件hash的自定义算法。这个命令用来根据 `qetag` 算法快速计算文件 `hash`。
+`qtag` 算法是七牛用来计算文件 `hash` 的自定义算法。这个命令用来根据 `qetag` 算法快速计算文件 `hash`。
 
 参考文档：[qetag](https://github.com/qiniu/qetag)
 
diff --git a/docs/qshell.md b/docs/qshell.md
@@ -1,5 +1,5 @@
 # 简介
-`qshell` 是利用 [七牛文档上公开的API](http://developer.qiniu.com) 实现的一个方便开发者测试和使用七牛API服务的命令行工具。该工具设计和开发的主要目的就是帮助开发者快速解决问题。目前该工具融合了七牛存储，CDN，以及其他的一些七牛服务中经常使用到的方法对应的便捷命令，比如b64decode，就是用来解码七牛的URL安全的Base64编码用的，所以这是一个面向开发者的工具，任何新的被认为适合加到该工具中的命令需求，都可以在 [ISSUE列表](https://github.com/qiniu/qshell/issues) 里面提出来，我们会尽快评估实现，以帮助大家更好地使用七牛服务。
+`qshell` 是利用 [七牛文档上公开的API](http://developer.qiniu.com) 实现的一个方便开发者测试和使用七牛 API 服务的命令行工具。该工具设计和开发的主要目的就是帮助开发者快速解决问题。目前该工具融合了七牛存储，CDN，以及其他的一些七牛服务中经常使用到的方法对应的便捷命令，比如 b64decode，就是用来解码七牛的 URL 安全的 Base64 编码用的，所以这是一个面向开发者的工具，任何新的被认为适合加到该工具中的命令需求，都可以在 [ISSUE列表](https://github.com/qiniu/qshell/issues) 里面提出来，我们会尽快评估实现，以帮助大家更好地使用七牛服务。
 
 
 # 更新日志 
@@ -8,27 +8,26 @@
 
 # 命令任何位置运行
 **Linux和Mac平台**
-对于 Linux 或者 Mac，如果希望能够在任何位置都可以执行，那么可以把 `qshell` 所在的目录加入到环境变量 `$PATH` 中去。假设 `qshell` 命令被解压到路径`/home/jemy/tools` 目录下面，那么我们可以把如下的命令写入到你所使用的 bash 所对应的配置文件中，如果是 `/bin/bash`，那么就是 `~/.bashrc` 文件，如果是 `/bin/zsh `，那么就是 `~/.zshrc` 文件中。写入的内容为：
+对于 Linux 或者 Mac，如果希望能够在任何位置都可以执行，那么可以把 `qshell` 所在的目录加入到环境变量 `$PATH` 中去。假设 `qshell` 命令被解压到路径 `/home/jemy/tools` 目录下面，那么我们可以把如下的命令写入到你所使用的 bash 所对应的配置文件中，如果是 `/bin/bash`，那么就是 `~/.bashrc` 文件，如果是 `/bin/zsh `，那么就是 `~/.zshrc` 文件中。写入的内容为：
 ```
 export PATH=$PATH:/home/jemy/tools
 ```
 保存完毕之后，可以通过两种方式立即生效，其一为输入 `source ~/.zshrc` 或者 `source ~/.bashrc` 来使配置立即生效，或者完全关闭命令行，然后重新打开一个即可，接下来就可以在任何位置使用 `qshell` 命令了。
 
 **Windows平台**
-如果你希望可以在任意目录下使用 `qshell`，请将 `qshell` 工具可执行文件所在目录添加到系统的环境变量中。由于 Windows 系统是图形界面，所以方便一点。假设`qshell.exe` 命令被保存到路径 `E:\jemy\tools` 目录下面，那么我们把这个目录放到系统的环境变量 `PATH` 里面。
+如果你希望可以在任意目录下使用 `qshell`，请将 `qshell` 工具可执行文件所在目录添加到系统的环境变量中。由于 Windows 系统是图形界面，所以方便一点。假设 `qshell.exe` 命令被保存到路径 `E:\jemy\tools` 目录下面，那么我们把这个目录放到系统的环境变量 `PATH` 里面。
 注：
 本工具是一个命令行工具，在 Windows 下面请先打开命令行终端，然后输入工具名称执行，不要双击打开，否则会出现闪退现象。
 
 
 # 快速使用
 该工具有两类命令，一类需要鉴权，另一类不需要。需要鉴权的命令都需要依赖七牛账号下的 `AccessKey`, `SecretKey`和 `Name`。所以这类命令运行之前，需要使用 `account` 命令来添加 `AccessKey` ，`SecretKey`和`Name` 。
-`Name`是用户可以自定义的字符串，用来唯一表示AccessKey/SecretKey账户，qshell会对添加的每一个账户信息加密保存，可以使用自命令`user`进行切换，切换账户的时候，需要使用账户唯一标识
-`Name`。
+`Name`是用户可以自定义的字符串，用来唯一表示 AccessKey/SecretKey 账户，qshell 会对添加的每一个账户信息加密保存，可以使用自命令 `user` 进行切换，切换账户的时候，需要使用账户唯一标识 `Name`。
 ```
 $ qshell account <Your AccessKey> <Your SecretKey> <Your Name>
 ```
 
-其中name表示该账号的名称, 如果 ak, sk, name 首字母是"-", 需要使用如下的方式添加账号, 这样避免把该项识别成命令行选项:
+其中name表示该账号的名称, 如果 ak, sk, name 首字母是 "-", 需要使用如下的方式添加账号, 这样避免把该项识别成命令行选项:
 ```
 $ qshell account -- <Your AccessKey> <Your SecretKey> <Your Name>
 ```
diff --git a/docs/qupload.md b/docs/qupload.md
diff --git a/docs/reqid.md b/docs/reqid.md
diff --git a/docs/restorear.md b/docs/restorear.md
diff --git a/docs/sync.md b/docs/sync.md
diff --git a/docs/tms2d.md b/docs/tms2d.md
diff --git a/docs/token.md b/docs/token.md
diff --git a/docs/ts2d.md b/docs/ts2d.md
diff --git a/docs/unzip.md b/docs/unzip.md
diff --git a/docs/urldecode.md b/docs/urldecode.md
diff --git a/docs/urlencode.md b/docs/urlencode.md
