Skip to content

Fix some minor nits in the manual page #86

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Fix some minor nits in the manual page #86

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6666b4a
manual page: drop an unneeded .Oc
ppentchev Feb 14, 2025
582e9a8
manual page: sentences on separate lines
ppentchev Feb 14, 2025
93e85e0
manual page: correct two minor grammar nits
ppentchev Feb 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 22 additions & 13 deletions microsocks.1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
.Op Fl p Ar port
.Op Fl u Ar user
.Op Fl w Ar ips
.Oc
.El
.Ek
.Sh DESCRIPTION
Expand All @@ -24,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.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what's the point of selectively making some lines short ?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I went for a minimal-change approach: I only inserted a line break at the beginning of every sentence, I didn't change the already-existing line breaks in the middle of sentences. Let me know if you want me to also reflow the sentences so that short ones are now on a single line.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i really don't even want to be reminded this manpage exists, even less spend any time on maintaining it. i'm already feeling that it was a bad idea to add it.

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
Expand All @@ -39,36 +40,44 @@ 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
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 for 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
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 .
Expand Down