From 6666b4a4a9877e118499d16b4ac973145f79c12d Mon Sep 17 00:00:00 2001 From: Peter Pentchev Date: Fri, 14 Feb 2025 15:47:27 +0200 Subject: [PATCH 1/3] manual page: drop an unneeded .Oc --- microsocks.1 | 1 - 1 file changed, 1 deletion(-) diff --git a/microsocks.1 b/microsocks.1 index 68bb189..8682468 100644 --- a/microsocks.1 +++ b/microsocks.1 @@ -15,7 +15,6 @@ .Op Fl p Ar port .Op Fl u Ar user .Op Fl w Ar ips -.Oc .El .Ek .Sh DESCRIPTION From 582e9a8dfd0186b2a937d4c5215cbe2723a068fd Mon Sep 17 00:00:00 2001 From: Peter Pentchev Date: Fri, 14 Feb 2025 15:46:47 +0200 Subject: [PATCH 2/3] manual page: sentences on separate lines --- microsocks.1 | 30 ++++++++++++++++++++---------- 1 file changed, 20 insertions(+), 10 deletions(-) diff --git a/microsocks.1 b/microsocks.1 index 8682468..98b1b70 100644 --- a/microsocks.1 +++ b/microsocks.1 @@ -23,8 +23,10 @@ is a multithreaded, tiny, portable SOCKS5 server with very moderate resource usage that you can run on your remote boxes to tunnel connections through them, if for some reason SSH doesn't cut it for you. It is very lightweight, and very light on resources too: for every client, a -thread with a low stack size is spawned. the main process basically doesn't -consume any resources at all. It is also designed to be robust: it handles +thread with a low stack size is spawned. +The main process basically doesn't +consume any resources at all. +It is also designed to be robust: it handles resource exhaustion gracefully by simply denying new connections, instead of calling .Xr abort 3 @@ -38,10 +40,13 @@ The following options are supported by .It Fl 1 Activates auth_once mode: once a specific IP address authorized successfully with user:password pair, it is added to a whitelist and may use the proxy -without authorization. This is handy for programs like Firefox that don't -support user:password authorization. For it to work you'd basically make one +without authorization. +This is handy for programs like Firefox that don't +support user:password authorization. +For it to work you'd basically make one connection with another program that supports it, and then you can use Firefox -too. This option requires options +too. +This option requires options .Fl u and .Fl P @@ -49,20 +54,25 @@ also to be specified. .It Fl b Ar ip Specifies IP address outgoing connections are bound to. .It Fl i Ar addr -Specifies local address to listen connections on. Host name or IP address can be -supplied. Default to +Specifies local address to listen connections on. +Host name or IP address can be +supplied. +Default to .Cm 0.0.0.0 . .It Fl P -Specifies authorization password. This option requires +Specifies authorization password. +This option requires .Fl u also to be specified. .It Fl p -TCP port to listen to. Default to +TCP port to listen to. +Default to .Cm 1080 . .It Fl q Quiet mode: suppress logging messages. .It Fl u -Specifies authorization username value. This option requires +Specifies authorization username value. +This option requires .Fl P also to be specified. .It Fl w From 93e85e03e5b32f99f431cd99de79546132018281 Mon Sep 17 00:00:00 2001 From: Peter Pentchev Date: Fri, 14 Feb 2025 15:49:19 +0200 Subject: [PATCH 3/3] manual page: correct two minor grammar nits --- microsocks.1 | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/microsocks.1 b/microsocks.1 index 98b1b70..fd4bd48 100644 --- a/microsocks.1 +++ b/microsocks.1 @@ -54,7 +54,7 @@ also to be specified. .It Fl b Ar ip Specifies IP address outgoing connections are bound to. .It Fl i Ar addr -Specifies local address to listen connections on. +Specifies local address to listen for connections on. Host name or IP address can be supplied. Default to @@ -76,8 +76,8 @@ This option requires .Fl P also to be specified. .It Fl w -A comma-separated whitelist of IP addresses, that may use the proxy without -authentication. e.g. +A comma-separated whitelist of IP addresses that may use the proxy without +authentication, e.g. .Cm -w 127.0.0.1,192.168.1.1.1,::1 or just .Cm -w 10.0.0.1 .