diff options
| -rw-r--r-- | CHANGELOG.md | 2 | ||||
| -rw-r--r-- | README.md | 4 | ||||
| -rw-r--r-- | WINDOWS_GUIDE.txt | 4 | ||||
| -rw-r--r-- | dpibreak.1.in | 6 | ||||
| -rw-r--r-- | res/windows_bats/service_install.bat | 2 | ||||
| -rw-r--r-- | src/opt.rs | 12 |
6 files changed, 19 insertions, 11 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md index e1fcd8d..beba949 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,8 @@ ### Added - Option `-o, --segment-order`: configure segment boundaries and transmission order of the TLS ClientHello. (#20) +- Short option `-d` for `--daemon`, deprecating `-D` (will be removed + on v1.0.0). ### Changed - Renamed "fragment" to "segmentation" in `README.md`. @@ -96,10 +96,10 @@ source](https://github.com/dilluti0n/dpibreak/blob/master/install.sh). Usage: ```bash sudo dpibreak -sudo dpibreak -D # run as daemon +sudo dpibreak -d # run as daemon sudo pkill dpibreak # to stop daemon sudo dpibreak --fake-autottl # enable fake packet injection -sudo dpibreak -D --fake-autottl +sudo dpibreak -d --fake-autottl dpibreak --help man 1 dpibreak # manual ``` diff --git a/WINDOWS_GUIDE.txt b/WINDOWS_GUIDE.txt index 91c2513..0df97a3 100644 --- a/WINDOWS_GUIDE.txt +++ b/WINDOWS_GUIDE.txt @@ -13,7 +13,7 @@ Normal start: Windows service (automatically start at boot): * Install & start: Right click service_install.bat -> Run as administrator - DPIBreak will automatically start per boot - - See `-D, --daemon' of manual for more information. + - See `-d, --daemon' of manual for more information. * Uninstall: Right click service_remove.bat -> Run as administrator Troubleshooting: @@ -38,7 +38,7 @@ DPIBreak Windows 사용 안내 Windows 서비스 (부팅 시 자동 실행): * 설치 및 시작: service_install.bat 우클릭 -> 관리자 권한으로 실행 - 부팅 시 DPIBreak가 자동으로 시작됩니다. - - 자세한 내용은 설명서의 `-D, --daemon' 항목을 참고하세요. + - 자세한 내용은 설명서의 `-d, --daemon' 항목을 참고하세요. * 제거: service_remove.bat 우클릭 -> 관리자 권한으로 실행 문제 해결: diff --git a/dpibreak.1.in b/dpibreak.1.in index 8fbb1b6..4d99dfa 100644 --- a/dpibreak.1.in +++ b/dpibreak.1.in @@ -42,7 +42,7 @@ This only applies to TLS-based connections (HTTPS). UDP/QUIC (\fBRFC .SH OPTIONS .TP -.BR \-D ", " \-\-daemon +.BR \-d ", " \-\-daemon Run as a background daemon. Logs are written to .B /var/log/dpibreak.log. If a daemon is already running, it will fail with "unable to lock pid @@ -53,7 +53,7 @@ as root. .PP On Windows, this option enters the service controller entry point. Example: -.B sc create dpibreak binPath= \(dqdpibreak.exe \-D\(dq start= auto; sc start dpibreak +.B sc create dpibreak binPath= \(dqdpibreak.exe \-d\(dq start= auto; sc start dpibreak .RE .TP .B \-\-delay\-ms \fI<u64>\fR @@ -157,7 +157,7 @@ Run with default options: Run as daemon with fake ClientHello injection: .PP .RS -.B dpibreak \-D \-\-fake\-autottl +.B dpibreak \-e \-\-fake\-autottl .RE .PP Send the TLS ClientHello with the second byte first, followed by the diff --git a/res/windows_bats/service_install.bat b/res/windows_bats/service_install.bat index 6158bae..1b199c2 100644 --- a/res/windows_bats/service_install.bat +++ b/res/windows_bats/service_install.bat @@ -8,7 +8,7 @@ @pause @rem Add --fake-autottl below (next to ARGS=) to use fake -@set "ARGS=-D" +@set "ARGS=-d" @set "EXE=%~dp0dpibreak.exe" @set "SERVNAME=dpibreak" @@ -145,13 +145,19 @@ impl Opt { let mut args = std::env::args().skip(1); // program name let mut warned_loglevel_deprecated = false; + let mut warned_D_deprecated = false; while let Some(arg) = args.next() { let argv = arg.as_str(); match argv { "-h" | "--help" => { usage(); std::process::exit(0); } - "-D" | "--daemon" => { + "-d" | "-D" | "--daemon" => { + if argv == "--loglevel" && !warned_D_deprecated { + // FIXME(on release): remove this on v1.0.0 + warned_D_deprecated = true; + eprintln!("Note: `{arg}' has been deprecated since v0.6.0 and planned to be removed on v1.0.0. Use `-d' instead."); + } no_splash = true; // if it is unchanged explicitly by argument, set it to info if log_level == DEFAULT_LOG_LEVEL { @@ -164,7 +170,7 @@ impl Opt { if argv == "--loglevel" && !warned_loglevel_deprecated { // FIXME(on release): remove this on v1.0.0 warned_loglevel_deprecated = true; - eprintln!("Note: `{arg}' has been deprecated since v0.1.1. Use `--log-level' instead."); + eprintln!("Note: `{arg}' has been deprecated since v0.1.1 and planned to be removed on v1.0.0. Use `--log-level' instead."); } log_level = take_value(&mut args, argv)?; } @@ -307,7 +313,7 @@ where fn usage() { println!("Usage: dpibreak [OPTIONS]\n"); println!("Options:"); - println!(" -D, --daemon Run as daemon; kill `pidof dpibreak` to stop."); + println!(" -d, --daemon Run as daemon; kill `pidof dpibreak` to stop."); println!(" --delay-ms <u64> (default: {DEFAULT_DELAY_MS})"); #[cfg(target_os = "linux")] println!(" --queue-num <u16> (default: {DEFAULT_QUEUE_NUM})"); |