phetch/doc/phetch.1

.\" Generated by scdoc 1.10.0
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "PHETCH" "1" "2020-01-09"
.P
.SH NAME
.P
phetch - quick lil gopher client
.P
.SH SYNOPSIS
.P
\fBphetch\fR [\fIOPTIONS\fR] [\fIURL\fR]
.P
.SH OPTIONS
.P
\fB-l\fR, \fB--local\fR
.RS 4
Connect to the local Gopher server at URL \fI127.0.0.1:7070\fR.
.P
.RE
\fB-p\fR \fIURL\fR, \fB--print\fR \fIURL\fR
.RS 4
Print a rendered Gopher server response of \fIURL\fR and exit.
.P
.RE
\fB-r\fR \fIURL\fR, \fB--raw\fR \fIURL\fR
.RS 4
Print the raw Gopher server response of \fIURL\fR and exit.
.P
.RE
\fB-t\fR, \fB--tls\fR
.RS 4
Attempt to fetch all pages over TLS.
.P
.RE
\fB-h\fR, \fB--help\fR
.RS 4
Print a help summary and exit.
.P
.RE
\fB-v\fR, \fB--version\fR
.RS 4
Print version information and exit.
.P
.RE
.SH NOTES
.P
When given a \fIURL\fR, \fBphetch\fR will show the requested Gopher page and
enter interactive mode.
.P
Without a \fIURL\fR, \fBphetch\fR will show a builtin dashboard with easy
access to online help, bookmarks and history, and enter interactive
mode.
.P
.SH NAVIGATION
.P
.SS KEYBOARD SHORTCUTS
.P
All single letter commands also work with the \fBCtrl\fR key: e.g., \fBh\fR
and \fBCtrl-h\fR are synonyms.
.P
\fBh\fR
.RS 4
Go to builtin help page.
.RE
\fBq\fR
.RS 4
Quit \fBphetch\fR.
.P
.RE
\fBleft arrow\fR
.RS 4
Go back in history.
.RE
\fBright arrow\fR
.RS 4
Go forward in history.
.RE
\fBup arrow\fR, \fBp\fR, \fBk\fR
.RS 4
Select previous link.
.RE
\fBdown arrow\fR, \fBn\fR, \fBj\fR
.RS 4
Select next link.
.RE
\fBPgUp\fR, \fB-\fR
.RS 4
Scroll up by many lines.
.RE
\fBPgDn\fR, \fBSPACE\fR
.RS 4
Scroll down by many lines.
.P
.RE
\fBNumber key\fR
.RS 4
Open/select link.
.RE
\fBEnter\fR
.RS 4
Open current link.
.RE
\fBEsc\fR, \fBCtrl-c\fR
.RS 4
Cancel
.P
.RE
\fBf\fR, \fB/\fR
.RS 4
Find link in page.
.P
.RE
\fBg\fR
.RS 4
Go to Gopher URL.
.RE
\fBu\fR
.RS 4
Edit URL.
.RE
\fBy\fR
.RS 4
Copy URL.
.P
.RE
\fBb\fR
.RS 4
Show bookmarks.
.RE
\fBs\fR
.RS 4
Save bookmark.
.RE
\fBa\fR
.RS 4
Show history. (Mnemonic: \fBAll\fR pages/history)
.P
.RE
\fBr\fR
.RS 4
View raw source.
.RE
\fBw\fR
.RS 4
Toggle wide mode.
.P
.RE
.SS MENU NAVIGATION
.P
Up and down arrows
.RS 4
Use the up and down arrows, \fBj\fR and \fBk\fR keys, or \fBn\fR and \fBp\fR
keys to select links. Phetch will scroll for you, or you can
use page up and page down (or \fB-\fR and spacebar) to scroll by
many lines at once.
.P
.RE
Number keys
.RS 4
If there are few enough menu items, pressing a number key will
open a link. Otherwise, the first matching number will be
selected. Use \fBEnter\fR to open the selected link.
.P
.RE
Incremental search
.RS 4
Press \fBf\fR or \fB/\fR to activate search mode, then just start
typing. Phetch will look for the first case-insensitive match
and try to select it. Use arrow keys or \fBCtrl-p\fR/\fBCtrl-n\fR to cycle
through matches.
.P
.RE
.SH BOOKMARKS
.P
There are two ways to save the URL of the current page:
.P
\fBy\fR
.RS 4
Copy URL.
.RE
\fBs\fR
.RS 4
Save bookmark.
.P
.RE
Bookmarks will be saved to the file \fI~/.config/phetch/bookmarks.gph\fR if
the directory \fI~/.config/phetch/\fR exists.
.P
\fBb\fR
.RS 4
View saved bookmarks.
.P
.RE
The clipboard function uses \fBpbcopy\fR on MacOS, and \fBxsel\fR \fI-sel clip\fR
on Linux.
.P
.SH HISTORY
.P
If you create a \fIhistory.gph\fR file in \fI~/.config/phetch/\fR, each Gopher
URL you open will be stored there.
.P
New URLs are appended to the bottom, but loaded in reverse order, so
you'll see all the most recently visited pages first when you press 
the \fBa\fR key.
.P
Feel free to edit your history file directly, or share it with your
friends!
.P
.SH ABOUT
.P
Phetch is maintained by dvkt, and released under the MIT license.
.P
Phetch's Gopher hole:
.RS 4
\fIgopher://phkt.io/1/phetch\fR
.RE
Phetch's webpage:
.RS 4
\fIhttps://github.com/dvkt/phetch\fR