update documents and release new version v8.4.2

Author: NigelWu95

Makefile

@@ -1,4 +1,4 @@
-version=8.4.1
+version=8.4.2
 
 package_no_test:
 	mvn package -Dmaven.test.skip=true

docs/asyncfetch.md

@@ -8,7 +8,9 @@
 4. 交互式操作随时输入 url 进行抓取请参考[ interactive 操作](interactive.md)  
 
 ## 配置
+> config.txt
 ```
+path=
 process=asyncfetch
 ak/qiniu-ak=
 sk/qiniu-sk=
@@ -54,13 +56,15 @@ check-url=
 |ignore-same-key| true/false|为 false 时表示覆盖同名文件，为 true 表示不覆盖|  
 |check-url| true/false|表示是否在提交任务之前对回调地址进行简单的 post 请求验证（无body的纯post请求），默认为 true，如果无需验证则设置为 false|  
 
+运行参数：`-config=config.txt`
+
 ### 关于 url-index 和 md5-index
 当使用 file 数据源且 parse=tab/csv 时 [xx-]index(ex) 设置的下标必须为整数。url-index 表示输入行中含 url 的字段索引，未设置的情况下则使用
 key 字段加上 domain 的方式访问源文件地址，key 下标用 indexes 参数设置，默认会根据 parse 类型设置为 0 或 "key"，参见[ indexes 索引](datasource.md#关于-indexes-索引)
 及[关于 parse 和索引](datasource.md#关于-parse)，md5-index 为需要进行 md5 校验时输入 md5 值的字段下标，不设置则无效。  
 
 ### 命令行参数方式
 ```
--process=asyncfetch -ak= -sk= -to-bucket= -add-prefix= -protocol= -domain= -host= -callback-url= -callback-body= -callback-body-type= -callback-host= -file-type= -ignore-same-key=
+-path= -process=asyncfetch -ak= -sk= -to-bucket= -add-prefix= -protocol= -domain= -host= -callback-url= -callback-body= -callback-body-type= -callback-host= -file-type= -ignore-same-key=
 ```
 

docs/avinfo.md

@@ -7,7 +7,9 @@
 3. 交互式操作随时输入 url 进行查询请参考[ interactive 操作](interactive.md)  
 
 ## 配置
+> config.txt
 ```
+path=
 process=avinfo 
 protocol=
 domain=
@@ -22,12 +24,14 @@ url-index=
 |indexes|字符串| 设置输入行中 key 字段的下标（有默认值），参考[数据源 indexes 设置](datasource.md#1-公共参数)|  
 |url-index| 字符串| 通过 url 操作时需要设置的 url 索引（下标），未设置任何索引和 domain 时根据 parse 类型默认为 0 或 "url"|  
 
+运行参数：`-config=config.txt`
+
 ### 关于 url-index
 当使用 file 源且 parse=tab/csv 时 [xx-]index(ex) 设置的下标必须为整数。url-index 表示输入行含 url 形式的源文件地址，未设置的情况下则使用
 key 字段加上 domain 的方式访问源文件地址，key 下标用 indexes 参数设置，默认会根据 parse 类型设置为 0 或 "key"，参见[ indexes 索引](datasource.md#关于-indexes-索引)
 及[关于 parse 和索引](datasource.md#关于-parse)。  
 
 ### 命令行方式
 ```
--process=avinfo -protocol= -domain=
+-path= -process=avinfo -protocol= -domain=
 ```

docs/cdn.md

@@ -10,7 +10,9 @@
 
 ## 配置
 ### CDN 刷新缓存
+> config.txt
 ```
+path=
 process=cdnrefresh
 ak=
 sk=
@@ -30,6 +32,8 @@ is-dir=
 |url-index| 字符串| 通过 url 操作时需要设置的 url 索引（下标），未设置任何索引和 domain 时根据 parse 类型默认为 0 或 "url"|  
 |is-dir| true/false| 是否进行目录刷新，设置为 true 时，输入的 url 或 key 必须是目录形式（即以 / 结尾），默认为 false，表示进行 url 刷新|  
 
+运行参数：`-config=config.txt`
+
 #### 关于 url-index
 当 parse=tab/csv 时 [xx-]index(ex) 设置的下标必须为整数。url-index 表示输入行中存在 url 形式的源文件地址，未设置的情况下则默认从 key 字段
 加上 domain 的方式访问源文件地址，key 下标用 indexes 参数设置，默认会根据 parse 类型设置为 0 或 "key"，参见[ indexes 索引](datasource.md#关于-indexes-索引)
@@ -41,11 +45,13 @@ is-dir=
 
 #### 命令行方式
 ```
--process=cdnrefresh -ak= -sk= -bucket= -batch-size= 
+-path= -process=cdnrefresh -ak= -sk= -bucket= -batch-size= 
 ```
 
 ### CDN 资源预取
+> config.txt
 ```
+path=
 process=cdnprefetch
 ak=
 sk=
@@ -63,6 +69,8 @@ url-index=
 |indexes|字符串| 设置输入行中 key 字段的下标（有默认值），参考[数据源 indexes 设置](datasource.md#1-公共参数)|  
 |url-index| 字符串| 通过 url 操作时需要设置的 url 索引（下标），未设置任何索引和 domain 时根据 parse 类型默认为 0 或 "url"|  
 
+运行参数：`-config=config.txt`
+
 #### 关于 url-index
 当 parse=tab/csv 时 [xx-]index(ex) 设置的下标必须为整数。url-index 表示输入行中存在 url 形式的源文件地址，未设置的情况下则默认从 key 字段
 加上 domain 的方式访问源文件地址，key 下标用 indexes 参数设置，默认会根据 parse 类型设置为 0 或 "key"，参见[ indexes 索引](datasource.md#关于-indexes-索引)
@@ -73,11 +81,13 @@ url-index=
 
 #### 命令行方式
 ```
--process=cdnprefetch -ak= -sk= -bucket= 
+-path= -process=cdnprefetch -ak= -sk= -bucket= 
 ```
 
 ### CDN 刷新/预取结果查询
+> config.txt
 ```
+path=
 process=refreshquery/prefetchquery
 ak=
 sk=
@@ -95,6 +105,8 @@ url-index=
 |indexes|字符串| 设置输入行中 key 字段的下标（有默认值），参考[数据源 indexes 设置](datasource.md#1-公共参数)|  
 |url-index| 字符串| 通过 url 操作时需要设置的 url 索引（下标），未设置任何索引和 domain 时根据 parse 类型默认为 0 或 "url"|  
 
+运行参数：`-config=config.txt`
+
 #### 关于 url-index
 当 parse=tab/csv 时 [xx-]index(ex) 设置的下标必须为整数。url-index 表示输入行中存在 url 形式的源文件地址，未设置的情况下则默认从 key 字段
 加上 domain 的方式访问源文件地址，key 下标用 indexes 参数设置，默认会根据 parse 类型设置为 0 或 "key"，参见[ indexes 索引](datasource.md#关于-indexes-索引)
@@ -105,5 +117,5 @@ url-index=
 
 #### 命令行方式
 ```
--process=refreshquery/prefetchquery -ak= -sk= -bucket= -batch-size= 
+-path= -process=refreshquery/prefetchquery -ak= -sk= -bucket= -batch-size= 
 ```

docs/censor.md

@@ -12,7 +12,9 @@
 ### 图片审核
 审核 image 类型的资源，同步审核，审核结果输出为 json：[七牛图片审核响应 json](https://developer.qiniu.com/censor/api/5588/image-censor#4)
 如果数据源的资源类型不确定（如云存储数据源），建议设置 filter 选项：f-mime=image  
+> config.txt
 ```
+path=
 process=imagecensor
 ak=
 sk=
@@ -48,8 +50,10 @@ queries 参数用于设置 url 的后缀或 ?+参数部分，内容审核可能
 ### 视频审核
 审核 video 类型的资源，异步审核，审核结果输出为 jobId，要获取进一步的实际审核结果需要通过 id 查询，参考该工具的 [censorresult 操作](censorresult.md)，
 七牛官网文档见：[通过jobid获取视频审核结果](https://developer.qiniu.com/censor/api/5620/video-censor#4)，如果数据源的资源类型不确定
-（如云存储数据源），建议设置 filter 选项：f-mime=video
+（如云存储数据源），建议设置 filter 选项：f-mime=video  
+> config.txt
 ```
+path=
 process=videocensor
 ak=
 sk=
@@ -81,6 +85,8 @@ private=
 |check-url| true/false|表示是否在提交任务之前对回调地址进行简单的 post 请求验证（无body的纯post请求），默认为 true，如果无需验证则设置为 false|  
 |private| 数据源私有类型|是否是对私有空间资源进行审核，选择对应的私有类型，参考[私有访问](#资源需要私有签名)|  
 
+运行参数：`-config=config.txt`
+
 ### 资源需要私有签名
 当进行图片审核的 url 需要通过私有鉴权访问时（资源来自于存储私有权限的空间），本工具支持串联操作，即先进行对应的私有签名再提交审核，使用如下的 private
 参数设置即可，如不需要进行私有访问则不设置，目前支持以下几类签名：  
@@ -93,6 +99,6 @@ private=
 
 ### 命令行参数方式
 ```
--process=imagecensor/videocensor -ak= -sk= -protocol= -domain= ...
+-path= -process=imagecensor/videocensor -ak= -sk= -protocol= -domain= ...
 ```
 

docs/censorresult.md

@@ -8,7 +8,9 @@
 4. 交互式操作随时输入 id 进行查询请参考[ interactive 操作](interactive.md)  
 
 ## 配置
+> config.txt
 ```
+path=
 process=censorresult
 ak=
 sk=
@@ -20,9 +22,11 @@ id-index=
 |ak、sk|长度 40 的字符串|七牛账号的ak、sk，通过七牛控制台个人中心获取|  
 |id-index| 字符串| 转码结果查询所需 jobId 的索引（下标），未设置任何索引时根据 parse 类型默认为 0 或 "id"|  
 
+运行参数：`-config=config.txt`
+
 ### 命令行方式
 ```
--process=censorresult -id-index=
+-path= -process=censorresult -id-index=
 ```
 
 ## 备注

docs/copy.md

@@ -8,7 +8,9 @@
 4. 交互式操作随时输入 key 进行复制请参考[ interactive 操作](interactive.md)  
 
 ## 配置
+> config.txt
 ```
+path=
 process=copy 
 ak=<ak> 
 sk=<sk> 
@@ -32,12 +34,14 @@ force=
 |rm-prefix| 字符串| 表示将原文件名去除存在的指定前缀后作为 copy 之后保存的文件名|  
 |force| true/false| 目标文件名如果目标空间中已存在是否进行强制覆盖，默认为 false|  
 
+运行参数：`-config=config.txt`
+
 ### 关于 toKey-index
 指定输入行中对应修改之后的文件名字段下标，不设置则无法进行解析，当使用 file 源且 parse=tab/csv 时下标必须为整数，toKey 下标和 key 字段下标不可
 相同，key 下标用 indexes 参数设置，默认会根据 parse 类型设置为 0 或 "key"，参见[ indexes 索引](datasource.md#关于-indexes-索引)及[关于 parse 和索引](datasource.md#关于-parse)。  
 **注意**：七牛存储空间不支持文件名以 `../`, `./` 开头或者包含 `/../`, `/./` 这种情况，会造成无法访问，因此设置文件名时请注意。  
 
 ### 命令行方式
 ```
--process=copy -ak= -sk= -bucket= -to-bucket= -toKey-index= -add-prefix= -rm-prefix=
+-path= -process=copy -ak= -sk= -bucket= -to-bucket= -toKey-index= -add-prefix= -rm-prefix=
 ```

docs/datamigration.md

@@ -52,6 +52,9 @@ path 来设置保存的文件名，主要可用于内网下载再上传的场景
 
 因此数据备份/迁移操作的配置参数主要包含两部分，即**数据源配置**和 **process 配置**，配置参考如下：  
 
+**Tip1**：如果使用配置文件的方式（推荐），假设配置文件名为 `config.txt`，则运行参数为：`-config=config.txt`  
+**Tip2**：如果使用命令行参数的方式，将各项参数加上 `-` 依次添加在命令中即可  
+
 #### 1. 阿里云 oss
 ```
 path=aliyun://<bucket>

docs/datasource.md

@@ -18,6 +18,7 @@
 \<bucket\> 名称或者 \<path\>-result 来创建目录。**  
 
 ### 1 公共参数
+> config.txt
 ```
 path=
 unit-len=
@@ -31,6 +32,8 @@ indexes=key,etag,fsize
 |threads| 整型数| 表示预期最大线程数，若实际得到的文件数或列举前缀数小于该值时以实际数目为准|  
 |indexes| 字符串列表| 资源元信息字段索引（下标），设置输入行对应的元信息字段下标|  
 
+运行参数：`-config=config.txt`
+
 **备注：** indexes、unit-len、threads 均有默认值非必填，indexes 说明及默认值参考下述[ indexes 索引](#关于-indexes-索引)，unit-len 和
 threads 说明及默认值参考下述[并发处理](#关于并发处理 )，建议根据需要优化参数配置。  
 
@@ -104,6 +107,7 @@ indexes 的设置通常采用第一种方式，即 `indexes=pre-<个数>`，如
 本地文件数据源分为**两种情况：（1）读取文件内容为数据列表按行输入（2）读取路径下的文件本身，包括目录遍历，得到文件信息作为输入**  
 ### 2.1 文本文件行读取  
 文件内容为资源列表，可按行读取输入文件的内容获取资源列表，文件行解析参数如下：  
+> config.txt
 ```
 parse=tab/json
 separator=\t
@@ -125,6 +129,8 @@ uri-config=
 |uris| 字符串|数据源路径下需要读取的文件名列表，如果只想处理部分文件，可使用参数设置列表的方式，以 `,` 号分割文件名，不设置默认读取 path 下全部文本文件|  
 |uri-config| 配置文件路径|配置文件格式为 json，表示 file 数据源中各列表的位置信息，文件名对应的值表示读取该文件的起始位置，可参考[ uri-config 配置](#关于-uri-config)|  
 
+运行参数：`-config=config.txt`
+
 #### 关于 parse
 数据源输入的文件列表为每行一条数据，parse 决定了数据的解析方式以及索引的设置方式，以下做简单举例说明，关于具体的其他索引设置参考对应 process 的文档。  
 如文件列表为 \t 分割的行：  
@@ -200,6 +206,7 @@ directory-config 中的目录名可以采取相对 path 路径下的目录名。
 |value| 表示数据源中某一行的内容，如 "qiniu_success_1.txt" 表示 "/Users/wubingheng/Projects/Github/test" 目录中可能存在该文件名|  
 
 ### 3 storage 云存储列举  
+> config.txt
 ```
 <密钥配置>
 region=
@@ -223,6 +230,8 @@ prefix-right=
 |prefix-left| true/false| 当设置多个前缀时，可选择是否列举所有前缀 ASCII 顺序之前的文件|  
 |prefix-right| true/false| 当设置多个前缀时，可选择是否列举所有前缀 ASCII 顺序之后的文件|  
 
+运行参数：`-config=config.txt`
+
 支持从不同的云存储上列举出空间文件，默认线程数(threads 参数)为 50，千万以内文件数量可以不增加线程，数据源路径等公共参数参考[公共参数配置](#1-公共参数)，
 通常云存储空间列举的必须参数包括密钥、空间名(通过 path 或 bucket 设置)及空间所在区域(通过 region 设置，允许不设置的情况下表明支持自动查询)，各数
 据源配置参数如下：  
@@ -312,7 +321,8 @@ threads 小于等于 100，100 万左右及以下的文件数量设置 threads 
 ```
 
 ## 数据源示例
-如果已设置账号，则不需要再直接设置密钥，可以通过 `-a=<account-name>`/`-d` 来读取账号，参考：[账号设置](../README.md#账号设置)  
+1、如果已设置账号，则不需要再直接设置密钥，可以通过 `-a=<account-name>`/`-d` 来读取账号，参考：[账号设置](../README.md#账号设置)  
+2、如果使用配置文件的方式，假设配置文件名为 `config.txt`，则运行参数为：`-config=config.txt`  
 
 ### 1 七牛云存储
 命令行参数示例：

docs/delete.md

@@ -8,7 +8,9 @@
 4. 交互式操作随时输入 key 进行删除请参考[ interactive 操作](interactive.md)  
 
 ## 配置
+> config.txt
 ```
+path=
 process=delete
 ak=
 sk=
@@ -22,7 +24,12 @@ indexes=
 |bucket| 字符串| 操作的资源所在空间，当数据源为 qiniu 时无需再设置|  
 |indexes|字符串| 设置输入行中 key 字段的下标（有默认值），参考[数据源 indexes 设置](datasource.md#1-公共参数)|  
 
+运行参数：`-config=config.txt`
+
 ### 命令行方式
 ```
--process=delete -ak= -sk= -bucket=  
+-path= -process=delete -ak= -sk= -bucket=  
 ```
+
+## 备注
+delete 是个高危操作，只有 bucket 参数的情况下会导致整个空间的文件被删除，请注意设置过滤条件，在正式执行前会有确认提示，请确认参数是否正确，谨慎操作！  

docs/domainsofbucket.md

@@ -7,14 +7,16 @@
 1. 支持通过 `-a=<account-name>`/`-d` 使用已设置的账号，则不需要再直接设置密钥，参考：[账号设置](../README.md#账号设置)  
 
 ## 使用方式
+#### 查询单个 bucket 的域名
 运行参数：  
 ```
-domainsfrom=<bucket> ak=<ak> sk=<sk>
+-domainsfrom=<bucket> -ak=<ak> -sk=<sk>
 ```  
 如使用 qsuits 执行器时：`qsuits -domainsfrom=temp -ak=xxx -sk=xxx`，ak、sk 是必须的要用于七牛鉴权，也可以使用 account 的方式来查询，如：
 `qsuits -domainsfrom=temp -a=myself`，会输出对应账号下 temp 空间绑定的所有域名。  
 
-另外，该操作其实也支持批量查询很多空间的绑定域名，但一般不需要这样做，如果希望这样做的话数据源**只能使用本地的文件列表**，即多个 bucket 名称以换行
+#### 批量查询 bucket 的域名
+该操作其实也支持批量查询很多空间的绑定域名，但一般不需要这样做，如果希望这样做的话数据源**只能使用本地的文件列表**，即多个 bucket 名称以换行
 形式存在于 text 文件列表中，如 bucket 列表：  
 ```
 temp1
@@ -25,9 +27,17 @@ temp5
 ```  
 列表文件名为 buckets.txt，那么可以使用如下配置：  
 ```
+path=buckets.txt
 process=domainsofbucket
 ak=
 sk=
 ```  
 同样 ak、sk 也可以使用 account 的方式。如果是运行交互式的命令行依次查询多个 bucket，则命令行加上 `-i` 参数即可，然后输入一个 bucket 名回车一
 次，即可依次查询输入 bucket 的域名。  
+
+运行参数：`-config=config.txt`
+
+### 命令行方式
+```
+-path= -process=domainsofbucket -ak= -sk=  
+```

docs/downloadfile.md

@@ -7,7 +7,9 @@
 3. 交互式操作随时输入 url 进行下载请参考[ interactive 操作](interactive.md)  
 
 ## 配置
+> config.txt
 ```
+path=
 process=download
 protocol=
 domain=
@@ -38,6 +40,8 @@ private=
 |down-path| 文件保存路径|设置下载文件的保存路径，为本地的目录名称，下载文件进行保存时必须设置|  
 |private| 数据源私有类型|是否是对私有空间资源进行下载，选择对应的私有类型，参考[私有访问](#资源需要私有签名)|  
 
+运行参数：`-config=config.txt`
+
 ### 关于 queries 参数
 queries 参数用于设置 url 的后缀或 ?+参数部分，资源下载可能需要下载不同格式或尺寸的如图片文件，因此可以通过一些图片处理样式或参数来设置对处理之后的
 图片进行下载。当设置 private（私有签名）的情况下，该参数会使用在 privateurl 操作中（因为 privateurl 操作在前，当前操作在后）。  
@@ -62,6 +66,6 @@ key 字段加上 domain 的方式访问源文件地址，key 下标用 indexes 
 
 ### 命令行参数方式
 ```
--process=download -ak= -sk= -protocol= -domain= -host= -add-prefix= -down-path= ...
+-path= -process=download -ak= -sk= -protocol= -domain= -host= -add-prefix= -down-path= ...
 ```