Skip to content

Commit

Permalink
Document socks proxy configuration.
Browse files Browse the repository at this point in the history
  • Loading branch information
martinh committed Oct 20, 2013
1 parent 86aef96 commit dbe1f00
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 1 deletion.
16 changes: 15 additions & 1 deletion manual/shell-fm.1
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Shell.FM \- Lightweight, console-based player for Last.FM radio streams.
.SH SYNOPSIS
.B shell-fm
[-d] [-i address] [-p port] [-b] [-D device] [-y proxy] [-h] lastfm://...
[-d] [-i address] [-p port] [-b] [-D device] [-y proxy] [-Y socks-proxy] [-h] lastfm://...
.SH DESCRIPTION
Shell.FM is a lightweight, console-based player for radio streams provided by
Last.FM.
Expand Down Expand Up @@ -35,6 +35,17 @@ is disabled. Default is /dev/audio.
.B \-y <proxy>
Make shell-fm use the given host as proxy server for HTTP requests.
.TP
.B \-Y <SOCKS proxy>
Make shell-fm use the given host as SOCKS proxy server for HTTP requests.
The following command uses OpenSSH to create a port forwarding to a remote
OpenSSH server acting as a SOCKS proxy server:
.PP
.RS
.nf
ssh -Nf -D 127.0.0.1:1080 remote.host
.fi
.RE
.TP
.B \-h
Print help text and exit.
.TP
Expand Down Expand Up @@ -264,6 +275,9 @@ shell-fm doesn't work completly profectly on.
.B proxy = proxy server
This allows you to specify a proxy server for the HTTP requests.
.TP
.B socks-proxy = SOCKS proxy server
This allows you to specify a SOCKS proxy server for the HTTP requests.
.TP
.B expiry = some-number
This defines the number of seconds until a cached page expires. The default is
86400 seconds (24 hours). You shouldn't set a very low value here, since the
Expand Down
1 change: 1 addition & 0 deletions source/main.c
Original file line number Diff line number Diff line change
Expand Up @@ -545,6 +545,7 @@ static void help(const char * argv0, int error_code) {
" -b batch mode.\n"
" -D device to play on.\n"
" -y proxy url to connect through.\n"
" -Y SOCKS proxy url to connect through.\n"
" -h this help.\n",
argv0
);
Expand Down

0 comments on commit dbe1f00

Please sign in to comment.