Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@nilaoda
nilaoda committed May 24, 2022
1 parent f744aa9 commit 7dd2b6c
Show file tree
Hide file tree
Showing 11 changed files with 172 additions and 98 deletions.
4 changes: 2 additions & 2 deletions N_m3u8DL-CLI/strings.Designer.cs
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion N_m3u8DL-CLI/strings.resx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -328,7 +328,7 @@
<value>设置下载速度上限(单位为KB/s)</value>
</data>
<data name="Help_proxyAddress" xml:space="preserve">
<value>设置HTTP/SOCK5代理, 如 http://127.0.0.1:8080</value>
<value>设置HTTP/SOCKS5代理, 如 http://127.0.0.1:8080</value>
</data>
<data name="Help_enableDelAfterDone" xml:space="preserve">
<value>开启下载后删除临时文件夹的功能</value>
Expand Down
93 changes: 61 additions & 32 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
本项目已于2019年10月9日开源，采用MIT许可证，各取所需。

# 关于跨平台
搁置了
未来可期

# N_m3u8DL-CLI
一个**简单易用的**m3u8下载器，下载地址：https://github.com/nilaoda/N_m3u8DL-CLI/releases
Expand Down Expand Up @@ -53,37 +53,66 @@

# 命令行选项
```
N_m3u8DL-CLI.exe <URL|File|JSON> [OPTIONS]
--workDir Directory 设定程序工作目录
--saveName Filename 设定存储文件名(不包括后缀)
--baseUrl BaseUrl 设定Baseurl
--headers headers 设定请求头，格式 key:value 使用|分割不同的key&value
--maxThreads Thread 设定程序的最大线程数(默认为32)
--minThreads Thread 设定程序的最小线程数(默认为16)
--retryCount Count 设定程序的重试次数(默认为15)
--timeOut Sec 设定程序网络请求的超时时间(单位为秒，默认为10秒)
--muxSetJson File 使用外部json文件定义混流选项
--useKeyFile File 使用外部16字节文件定义AES-128解密KEY
--useKeyBase64 Base64String 使用Base64字符串定义AES-128解密KEY
--useKeyIV HEXString 使用HEX字符串定义AES-128解密IV
--downloadRange Range 仅下载视频的一部分分片或长度
--liveRecDur HH:MM:SS 直播录制时，达到此长度自动退出软件
--stopSpeed Number 当速度低于此值时，重试(单位为KB/s)
--maxSpeed Number 设置下载速度上限(单位为KB/s)
--proxyAddress http://xx 设置HTTP代理, 如 http://127.0.0.1:8080
socks5://xx 设置SOCKS5代理, 如 socks5://127.0.0.1:8080
--enableDelAfterDone 开启下载后删除临时文件夹的功能
--enableMuxFastStart 开启混流mp4的FastStart特性
--enableBinaryMerge 开启二进制合并分片
--enableParseOnly 开启仅解析模式(程序只进行到meta.json)
--enableAudioOnly 合并时仅封装音频轨道
--disableDateInfo 关闭混流中的日期写入
--noMerge 禁用自动合并
--noProxy 不自动使用系统代理
--disableIntegrityCheck 不检测分片数量是否完整
--registerUrlProtocol 注册m3u8dl链接协议
--unregisterUrlProtocol 取消注册m3u8dl链接协议
N_m3u8DL-CLI
USAGE:
N_m3u8DL-CLI <URL|JSON|FILE> [OPTIONS]
OPTIONS:
--workDir 设定程序工作目录
--saveName 设定存储文件名(不包括后缀)
--baseUrl 设定Baseurl
--headers 设定请求头，格式 key:value 使用|分割不同的key&value
--maxThreads (Default: 32) 设定程序的最大线程数
--minThreads (Default: 16) 设定程序的最小线程数
--retryCount (Default: 15) 设定程序的重试次数
--timeOut (Default: 10) 设定程序网络请求的超时时间(单位为秒)
--muxSetJson 使用外部json文件定义混流选项
--useKeyFile 使用外部16字节文件定义AES-128解密KEY
--useKeyBase64 使用Base64字符串定义AES-128解密KEY
--useKeyIV 使用HEX字符串定义AES-128解密IV
--downloadRange 仅下载视频的一部分分片或长度
--liveRecDur 直播录制时，达到此长度自动退出软件(HH:MM:SS)
--stopSpeed 当速度低于此值时，重试(单位为KB/s)
--maxSpeed 设置下载速度上限(单位为KB/s)
--proxyAddress 设置HTTP/SOCKS5代理, 如 http://127.0.0.1:8080
--enableDelAfterDone 开启下载后删除临时文件夹的功能
--enableMuxFastStart 开启混流mp4的FastStart特性
--enableBinaryMerge 开启二进制合并分片
--enableParseOnly 开启仅解析模式(程序只进行到meta.json)
--enableAudioOnly 合并时仅封装音频轨道
--disableDateInfo 关闭混流中的日期写入
--disableIntegrityCheck 不检测分片数量是否完整
--noMerge 禁用自动合并
--noProxy 不自动使用系统代理
--registerUrlProtocol 注册m3u8dl链接协议
--unregisterUrlProtocol 取消注册m3u8dl链接协议
--help Display this help screen.
--version Display version information.
```

# 关于`m3u8dl://`协议
新增命令行参数：
```
--registerUrlProtocol 注册m3u8dl链接协议
--unregisterUrlProtocol 取消注册m3u8dl链接协议
```

URI格式：
```
m3u8dl:<base64编码的客户端命令行文本>
```

URI示例：
```
m3u8dl:Imh0dHBzOi8vZXhhbXBsZS5jb20vYWJjLm0zdTgiIC0td29ya0RpciAiJVVTRVJQUk9GSUxFJVxEb3dubG9hZHNcbTN1OGRsIiAtLXNhdmVOYW1lICJhYmMiIC0tZW5hYmxlRGVsQWZ0ZXJEb25lIC0tZGlzYWJsZURhdGVJbmZvIC0tbm9Qcm94eQ==
```

URI解码结果：
```
m3u8dl:"https://example.com/abc.m3u8" --workDir "%USERPROFILE%\Downloads\m3u8dl" --saveName "abc" --enableDelAfterDone --disableDateInfo --noProxy
```

# 用户文档
Expand Down
91 changes: 63 additions & 28 deletions README_ENG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,37 +30,72 @@ Supports:

## Options
```
N_m3u8DL-CLI.exe <URL|JSON|FILE> [OPTIONS]
N_m3u8DL-CLI
--workDir Directory Set work dir (Video will be here)
--saveName Filename Set save name(Exclude extention)
--baseUrl BaseUrl Set Baseurl
--headers headers Set HTTP headers，format: key:value user | split all key&value
--maxThreads Thread Set max thread(default: 32)
--minThreads Thread Set min thread(default: 16)
--retryCount Count Set retry times(default: 15)
--timeOut Sec Set timeout for http request(second，default: 10)
--muxSetJson File Set a json file for mux
--useKeyFile File Use 16 bytes file as KEY for AES-128 decryption
--useKeyBase64 Base64String Use Base64 String as KEY for AES-128 decryption
--useKeyIV HEXString Use HEX String as IV for AES-128 decryption
--downloadRange Range Set range for a video
--stopSpeed Number Speed below this, retry(KB/s)
--maxSpeed Number Set max download speed(KB/s)
--proxyAddress http://xx Set HTTP Proxy, like http://127.0.0.1:8080
--enableDelAfterDone Enable delete clips after download completed
--enableMuxFastStart Enable fast start for mp4
--enableBinaryMerge Enable use binary merge instead of ffmpeg
--enableParseOnly Enable parse mode
--enableAudioOnly Enable only audio track when mux use ffmpeg
--disableDateInfo Disable write date info when mux use ffmpeg
--noMerge Disable auto merge
--noProxy Disable use system proxy
--disableIntegrityCheck Disable integrity check
USAGE:
N_m3u8DL-CLI <URL|JSON|FILE> [OPTIONS]
OPTIONS:
--workDir Set work dir (Video will be here)
--saveName Set save name(Exclude extention)
--baseUrl Set Baseurl
--headers Set HTTP headers，format: key:value use | split all
key&value
--maxThreads (Default: 32) Set max thread
--minThreads (Default: 16) Set min thread
--retryCount (Default: 15) Set retry times
--timeOut (Default: 10) Set timeout for http request(second)
--muxSetJson Set a json file for mux
--useKeyFile Use 16 bytes file as KEY for AES-128 decryption
--useKeyBase64 Use Base64 String as KEY for AES-128 decryption
--useKeyIV Use HEX String as IV for AES-128 decryption
--downloadRange Set range for a video
--liveRecDur When the live recording reaches this length, the
software will exit automatically(HH:MM:SS)
--stopSpeed Speed below this, retry(KB/s)
--maxSpeed Set max download speed(KB/s)
--proxyAddress Set HTTP/SOCKS5 Proxy, like http://127.0.0.1:8080
--enableDelAfterDone Enable delete clips after download completed
--enableMuxFastStart Enable fast start for mp4
--enableBinaryMerge Enable use binary merge instead of ffmpeg
--enableParseOnly Enable parse only mode
--enableAudioOnly Enable only audio track when mux use ffmpeg
--disableDateInfo Disable write date info when mux use ffmpeg
--disableIntegrityCheck Disable integrity check
--noMerge Disable auto merge
--noProxy Disable use system proxy
--registerUrlProtocol Register m3u8dl URL protocol
--unregisterUrlProtocol Unregister m3u8dl URL protocol
--help Display this help screen.
--version Display version information.
```


## About `m3u8dl://`
New commandline options：
```
--registerUrlProtocol Register m3u8dl URL protocol
--unregisterUrlProtocol Unregister m3u8dl URL protocol
```

URI Format：
```
m3u8dl:<base64 encoded params>
```

URI Example：
```
m3u8dl:Imh0dHBzOi8vZXhhbXBsZS5jb20vYWJjLm0zdTgiIC0td29ya0RpciAiJVVTRVJQUk9GSUxFJVxEb3dubG9hZHNcbTN1OGRsIiAtLXNhdmVOYW1lICJhYmMiIC0tZW5hYmxlRGVsQWZ0ZXJEb25lIC0tZGlzYWJsZURhdGVJbmZvIC0tbm9Qcm94eQ==
```

URI Decode Result：
```
m3u8dl:"https://example.com/abc.m3u8" --workDir "%USERPROFILE%\Downloads\m3u8dl" --saveName "abc" --enableDelAfterDone --disableDateInfo --noProxy
```

## Document
https://nilaoda.github.io/N_m3u8DL-CLI/
https://nilaoda.github.io/N_m3u8DL-CLI/

## Chit-chat
https://discord.gg/W5tvcRJDPs
Loading

0 comments on commit 7dd2b6c

Please sign in to comment.