geminawk/README

66 lines
1.7 KiB
Plaintext

GEMINAWK(1) General Commands Manual GEMINAWK(1)
NAME
geminawk - a Gemini client written with awk(1)
SYNOPSIS
geminawk [-R] [-h hostname] [-p default-port] [-r max-redirects]
URL ...
DESCRIPTION
Fetch URL using the Gemini protocol.
The options are as follows:
-R Request URL exactly as it is given.
-h hostname
The actual hostname to make requests to. This allows for
proxying, and other similar situations.
-p default-port
Set the default port to use when there is no port in the
URL. (default 1965)
-r max-redirects
Set the maximum number of redirects to follow. (default 5)
ENVIRONMENT
NC The path to for, or to call in place of, nc(1).
NCFLAGS
The flags to pass to NC.
HOST The hostname to make requests to (-h hostname).
PORT The default port number (-p default-port).
REDIRECTS
The maximum number of redirects (-r max-redirects).
SEE ALSO
awk(1), nc(1), openssl(1)
EXIT STATUS
The geminawk utility exits 0 on success, and >0 if an error occurs.
EXAMPLES
Request a page through a different hostname:
geminawk -h localhost gemini.example
Request an absolute path:
geminawk -Rh gemini.example /path/to/resource
Make a request using torsocks(1):
NC='torsocks nc' geminawk address.onion
CAVEATS
By default, this only works with the OpenBSD, or LibreSSL, nc(1).
If a compatible version is not found, geminawk defaults to using
s_client from openssl(1).
To use a different program for the TLS connection set the NC and
NCFLAGS environment variables, or edit the script itself.
June 10, 2020