diff options
author | Jan-Michael Brummer <jan.brummer@tabos.org> | 2023-05-03 14:19:56 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-05-03 14:19:56 +0200 |
commit | e81f7b300429e8cbc41438f6f87ecefe6dff17de (patch) | |
tree | bd42a732d4040cbe8105146c5f3d16b3e9341635 | |
parent | de3bc3908649b6b0e8d1ee491ad51a03bb8ec5a4 (diff) | |
download | libproxy-git-e81f7b300429e8cbc41438f6f87ecefe6dff17de.tar.gz |
Add man page for proxy tool (#204)
Fixes: https://github.com/libproxy/libproxy/issues/190
-rw-r--r-- | src/tools/meson.build | 4 | ||||
-rw-r--r-- | src/tools/proxy.8 | 34 |
2 files changed, 37 insertions, 1 deletions
diff --git a/src/tools/meson.build b/src/tools/meson.build index 0c0b816..fde05a4 100644 --- a/src/tools/meson.build +++ b/src/tools/meson.build @@ -8,4 +8,6 @@ executable( dependencies: libproxy_dep, install: true, include_directories: libproxy_inc -)
\ No newline at end of file +) + +install_man('proxy.8')
\ No newline at end of file diff --git a/src/tools/proxy.8 b/src/tools/proxy.8 new file mode 100644 index 0000000..0110815 --- /dev/null +++ b/src/tools/proxy.8 @@ -0,0 +1,34 @@ +.TH PROXY 8 + +.SH NAME + +proxy \- Libproxy test tool + +.SH SYNOPSIS +.SY proxy +.B [\fIscheme://host\fB][:\fIport\fB] + +.SH DESCRIPTION +The program +.B proxy +displays the proxy server that should be used to reach a given network resource. +You can provide a URL as a parameter or start the tool in interactive mode to enter multiple URLs. +As a return value the required proxy will be displayed. + +libproxy is a library that provides automatic proxy configuration management using different backends. + +.SH EXAMPLE +# proxy http://www.example.com + +# http://127.0.0.1:8080 + + +.SH DEBUG OUTPUT +In order to show further debug output you can set the environment variable +.B PX_DEBUG=1 + +During execution the tool now shows internal library information like existing +plugin modules, which configuration is used and the return values. + +.SH AUTHORS +Jan-Michael Brummer <jan-michael.brummer1@volkswagen.de>
\ No newline at end of file |