diff --git a/CMakeLists.txt b/CMakeLists.txt index 68cf2ee..76f45df 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -25,3 +25,17 @@ install(FILES cgproxy.service DESTINATION /usr/lib/systemd/system/) install(FILES config.json DESTINATION /etc/cgproxy/) install(FILES cgroup-tproxy.sh DESTINATION /usr/share/cgproxy/scripts/) install(FILES readme.md DESTINATION /usr/share/doc/cgproxy/) + +# man pages +set(man_gz +${PROJECT_BINARY_DIR}/cgproxyd.1.gz +${PROJECT_BINARY_DIR}/cgproxy.1.gz +${PROJECT_BINARY_DIR}/cgnoproxy.1.gz +) +add_custom_target(man + COMMAND gzip -fk cgproxyd.1 cgproxy.1 cgnoproxy.1 + COMMAND mv *.gz ${PROJECT_BINARY_DIR} + WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/man +) +add_dependencies(main man) +install(FILES ${man_gz} DESTINATION /usr/share/man/man1/) \ No newline at end of file diff --git a/man/cgnoproxy.1 b/man/cgnoproxy.1 new file mode 100644 index 0000000..ddf39f5 --- /dev/null +++ b/man/cgnoproxy.1 @@ -0,0 +1,14 @@ +.\" Manpage for cgproxyd +.TH man 1 "19 May 2020" "1.0" "cgnoproxy man page" +.SH NAME +cgnoproxy \- Run program without proxy +.SH SYNOPSIS +cgnoproxy [--help] [--debug] +.SH ALIAS +cgnoproxy = cgproxy --noproxy +.SH DESCRIPTION +cgnoproxy send current running process pid to cgproxyd through unix socket, then pid is attached to non-proxied cgroup +.SH EXAMPLES +cgnoproxy sudo v2ray -config config_file +.SH SEE ALSO +cgproxyd(1), cgproxy(1), cgnoproxy(1) diff --git a/man/cgproxy.1 b/man/cgproxy.1 new file mode 100644 index 0000000..1f9851b --- /dev/null +++ b/man/cgproxy.1 @@ -0,0 +1,12 @@ +.\" Manpage for cgproxyd +.TH man 1 "19 May 2020" "1.0" "cgproxy man page" +.SH NAME +cgproxy \- Run program with proxy +.SH SYNOPSIS +cgproxy [--help] [--debug] +.SH DESCRIPTION +cgproxy send current running process pid to cgproxyd through unix socket, then pid is attached to proxied cgroup +.SH EXAMPLES +cgproxy curl -vI https://www.google.com +.SH SEE ALSO +cgproxyd(1), cgproxy(1), cgnoproxy(1) diff --git a/man/cgproxyd.1 b/man/cgproxyd.1 new file mode 100644 index 0000000..fa8cb4a --- /dev/null +++ b/man/cgproxyd.1 @@ -0,0 +1,30 @@ +.\" Manpage for cgproxyd +.TH man 1 "19 May 2020" "1.0" "cgproxyd man page" +.SH NAME +cgproxyd \- Start a daemon with unix socket to accept control from cgproxy/cgnoproxy +.SH SYNOPSIS +cgproxyd [--help] [--debug] +.SH ALIAS +cgproxyd = cgproxy --daemon +.SH CONFIGURATION +.I /etc/cgproxy/config.json +.br +.B port +tproxy listenning port +.br +.B cgroup_noproxy +cgroup array that no need to proxy, /noproxy.slice is preserved. +.br +.B cgroup_proxy +cgroup array that need to proxy, /proxy.slice is preserved. +.br +.B enable_gateway +enable gateway proxy for local devices. +.br +.B enable_dns +enable dns to go to proxy. +.br +.B enable_tcp enable_udp enable_ipv4 enable_ipv6 +.SH SEE ALSO +cgproxyd(1), cgproxy(1), cgnoproxy(1) +