mirror of https://github.com/xvxx/phetch
Add phetch(1) manual
Klaus Alexander Seistrup
4 years ago
committed by
dvkt
parent
f90f4aef7e
commit
d082f4ca0c
@ -0,0 +1,223 @@
|
||||
.\" 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-08"
|
||||
.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
|
||||
\fB←\fR, \fBleft arrow\fR
|
||||
.RS 4
|
||||
Go back in history.
|
||||
.RE
|
||||
\fB→\fR, \fBright arrow\fR
|
||||
.RS 4
|
||||
Go forward in history.
|
||||
.RE
|
||||
\fB↑\fR, \fBup arrow\fR, \fBp\fR, \fBk\fR
|
||||
.RS 4
|
||||
Select previous link.
|
||||
.RE
|
||||
\fB↓\fR, \fBdown arrow\fR, \fBn\fR, \fBj\fR
|
||||
.RS 4
|
||||
Select next link.
|
||||
.RE
|
||||
\fBPgUp\fR, \fBPgDn\fR
|
||||
.RS 4
|
||||
Scroll up or down by many lines.
|
||||
.RE
|
||||
\fB-\fR, \fBSPACE\fR
|
||||
.RS 4
|
||||
Same as \fBPgUp\fR and \fBPgDn\fR.
|
||||
.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
|
||||
Show gopher 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.
|
||||
.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 \fBp\fR/\fBn\fR to cycle
|
||||
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 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
|
||||
@ -0,0 +1,150 @@
|
||||
PHETCH(1)
|
||||
|
||||
# NAME
|
||||
|
||||
phetch - quick lil gopher client
|
||||
|
||||
# SYNOPSIS
|
||||
|
||||
*phetch* [_OPTIONS_] [_URL_]
|
||||
|
||||
# OPTIONS
|
||||
|
||||
*-l*, *--local*
|
||||
Connect to the local gopher server at URL _127.0.0.1:7070_.
|
||||
|
||||
*-p* _URL_, *--print* _URL_
|
||||
Print a rendered gopher server response of _URL_ and exit.
|
||||
|
||||
*-r* _URL_, *--raw* _URL_
|
||||
Print the raw gopher server response of _URL_ and exit.
|
||||
|
||||
*-t*, *--tls*
|
||||
Attempt to fetch all pages over TLS.
|
||||
|
||||
*-h*, *--help*
|
||||
Print a help summary and exit.
|
||||
|
||||
*-v*, *--version*
|
||||
Print version information and exit.
|
||||
|
||||
# NOTES
|
||||
|
||||
When given a _URL_, *phetch* will show the requested gopher page and
|
||||
enter interactive mode.
|
||||
|
||||
Without a _URL_, *phetch* will show a builtin dashboard with easy
|
||||
access to online help, bookmarks and history, and enter interactive
|
||||
mode.
|
||||
|
||||
# NAVIGATION
|
||||
|
||||
## KEYBOARD SHORTCUTS
|
||||
|
||||
All single letter commands also work with the *Ctrl* key: e.g., *h*
|
||||
and *Ctrl-h* are synonyms.
|
||||
|
||||
*h*
|
||||
Go to builtin help page.
|
||||
*q*
|
||||
Quit *phetch*.
|
||||
|
||||
*←*, *left arrow*
|
||||
Go back in history.
|
||||
*→*, *right arrow*
|
||||
Go forward in history.
|
||||
*↑*, *up arrow*, *p*, *k*
|
||||
Select previous link.
|
||||
*↓*, *down arrow*, *n*, *j*
|
||||
Select next link.
|
||||
*PgUp*, *PgDn*
|
||||
Scroll up or down by many lines.
|
||||
*-*, *SPACE*
|
||||
Same as *PgUp* and *PgDn*.
|
||||
|
||||
*Number key*
|
||||
Open/select link.
|
||||
*Enter*
|
||||
Open current link.
|
||||
*Esc*, *Ctrl-c*
|
||||
Cancel
|
||||
|
||||
*f*, */*
|
||||
Find link in page.
|
||||
|
||||
*g*
|
||||
Go to gopher URL.
|
||||
*u*
|
||||
Show gopher URL.
|
||||
*y*
|
||||
Copy URL.
|
||||
|
||||
*b*
|
||||
Show bookmarks.
|
||||
*s*
|
||||
Save bookmark.
|
||||
*a*
|
||||
Show history.
|
||||
|
||||
*r*
|
||||
View raw source.
|
||||
*w*
|
||||
Toggle wide mode.
|
||||
|
||||
## MENU NAVIGATION
|
||||
|
||||
Up and down arrows
|
||||
Use the up and down arrows, *j* and *k* keys, or *n* and *p*
|
||||
keys to select links. Phetch will scroll for you, or you can
|
||||
use page up and page down (or *-* and spacebar) to scroll by
|
||||
many lines at once.
|
||||
|
||||
Number keys
|
||||
If there are few enough menu items, pressing a number key will
|
||||
open a link. Otherwise, the first matching number will be
|
||||
selected. Use *Enter* to open the selected link.
|
||||
|
||||
Incremental search
|
||||
Press *f* or */* 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 *p*/*n* to cycle
|
||||
matches.
|
||||
|
||||
# BOOKMARKS
|
||||
|
||||
There are two ways to save the URL of the current page:
|
||||
|
||||
*y*
|
||||
Copy URL.
|
||||
*s*
|
||||
Save bookmark.
|
||||
|
||||
Bookmarks will be saved to the file _~/.config/phetch/bookmarks.gph_ if
|
||||
the directory _~/.config/phetch/_ exists.
|
||||
|
||||
*b*
|
||||
View saved bookmarks.
|
||||
|
||||
The clipboard function uses *pbcopy* on MacOS, and *xsel* _-sel clip_
|
||||
on Linux.
|
||||
|
||||
# HISTORY
|
||||
|
||||
If you create a _history.gph_ file in _~/.config/phetch/_, each gopher
|
||||
URL you open will be stored there.
|
||||
|
||||
New URLs are appended to the bottom, but loaded in reverse order, so
|
||||
you'll see the most recently visited pages first when you press the
|
||||
*a* key.
|
||||
|
||||
Feel free to edit your history file directly, or share it with your
|
||||
friends!
|
||||
|
||||
# ABOUT
|
||||
|
||||
Phetch is maintained by dvkt, and released under the MIT license.
|
||||
|
||||
Phetch's gopher hole:
|
||||
_gopher://phkt.io/1/phetch_
|
||||
Phetch's webpage:
|
||||
_https://github.com/dvkt/phetch_
|
||||
Loading…
Reference in New Issue