Greetings,
I'm learning offpunk's commands and felt the need to have a complete list instead of constantly consulting it.
I don't know if it exists somewhere, but I ran a help <topic> for all the options available in Offpunk v2.8 and saved them in the document below (and attached).
I'm sharing it in case anyone is interested.
Thank you.
offpunk-v2.8-help.md
Offpunk v2.8
help
Documented commands (type help <topic>):
========================================
- add
- copy
- gus
- ls
- quit
- set
- tutorial
- xkcd
- alias
- exit
- handler
- mark
- redirect
- shell
- up
- archive
- feed
- help
- move
- reload
- subscribe
- url
- back
- find
- history
- offline
- root
- sync
- version
- bookmarks
- forward
- info
- online
- save
- theme
- view
- certs
- go
- list
- open
- search
- tour
- wikipedia
To render images inline, you need either chafa >= 1.10 or timg > 1.3.2
========================================
add
Add the current URL to the list specified as argument.
If no argument given, URL is added to Bookmarks.
You can pass a link number as the second argument to add the link.
"add $LIST XX" will add link number XX to $LIST
alias
Create or modifiy an alias
alias : show all existing aliases
alias ALIAS : show the command linked to ALIAS
alias ALIAS CMD : create or replace existing ALIAS to be linked to command CMDf
archive
Archive current page by removing it from every list and adding it to
archives, which is a special historical list limited in size. It is similar to move archives.
back
Go back to the previous gemini item.
bookmarks
Show or access the bookmarks menu.
'bookmarks' shows all bookmarks.
'bookmarks n' navigates immediately to item n in the bookmark menu.
Bookmarks are stored using the 'add' command.
certs
Manage your client certificates (identities) for a site.
certs will display all valid certificates for the current site
certs new <name> <days-valid> <url[optional]> will create a new certificate, if no url is specified, the current open site will be used.
copy
Copy the content of the last visited page as gemtext/html in the clipboard.
Use with "url" as argument to only copy the adress.
Use with "raw" to copy ANSI content as seen in your terminal (with colour codes).
Use with "cache" to copy the path of the cached content.
Use with "title" to copy the title of the page.
Use with "link" to copy a link in the gemtext format to that page with the title.
exit
Exit Offpunk.
feed
Display RSS or Atom feeds linked to the current page.
find
Find in current page by displaying only relevant lines (grep).
forward
Go forward to the next gemini item.
go
Go to a gemini URL or marked item.
gus
Submit a search query to the geminispace.info search engine.
handler
View or set handler commands for different MIME types.
handler MIMETYPE : see handler for MIMETYPE
handler MIMETYPE CMD : set handler for MIMETYPE to CMD
in the CMD, %s will be replaced by the filename.
if no %s, it will be added at the end.
MIMETYPE can be the true mimetype or the file extension.
Examples:
handler application/pdf zathura %s
handler .odt lowriter
handler docx lowriter
help
ALARM! Recursion detected! ALARM! Prepare to eject!
history
Display history.
info
Display information about current page.
list
Manage list of bookmarked pages.
- list : display available lists
- list $LIST : display pages in $LIST
- list create $NEWLIST : create a new list
- list edit $LIST : edit the list
- list subscribe $LIST : during sync, add new links found in listed pages to tour
- list freeze $LIST : don’t update pages in list during sync if a cache already exists
- list normal $LIST : update pages in list during sync but don’t add anything to tour
- list delete $LIST : delete a list permanently (a confirmation is required)
- list help : print this help
See also :
- add $LIST (to add current page to $LIST or, by default, to bookmarks)
- move $LIST (to add current page to list while removing from all others)
- archive (to remove current page from all lists while adding to archives)
There’s no "delete" on purpose. The use of "archive" is recommended.
The following lists cannot be removed or frozen but can be edited with "list edit"
- list archives : contains last 200 archived URLs
- history : contains last 200 visisted URLs
- to_fetch : contains URLs that will be fetch during the next sync
- tour : contains the next URLs to visit during a tour (see "help tour")
ls
List contents of current index.
Use 'ls -l' to see URLs.
mark
Mark the current item with a single letter. This letter can then
be passed to the 'go' command to return to the current item later.
Think of it like marks in vi: 'mark a'='ma' and 'go a'=''a'.
Marks are temporary until shutdown (not saved to disk).
move
move LIST will add the current page to the list LIST.
With a major twist: current page will be removed from all other lists.
If current page was not in a list, this command is similar to add LIST.
offline
Use Offpunk offline by only accessing cached content
online
Use Offpunk online with a direct connection
open
Open current item with the configured handler or xdg-open.
Use "open url" to open current URL in a browser.
Use "open 2 4" to open links 2 and 4
You can combine with "open url 2 4" to open URL of links
see "handler" command to set your handler.
quit
Exit Offpunk.
redirect
Display and manage the list of redirected URLs. This features is mostly useful to use privacy-friendly frontends for popular websites.
reload
Reload the current URL.
root
Go to root selector of the server hosting current item.
save
Save an item to the filesystem.
'save n filename' saves menu item n to the specified filename.
'save filename' saves the last viewed item to the specified filename.
'save n' saves menu item n to an automagic filename.
search
Search on Gemini using the engine configured (by default kennedy.gemi.dev)
You can configure it using "set search URL".
URL should contains one "%s" that will be replaced by the search term.
set
View or set various options.
shell
Send the content of the current page to the shell and pipe it.
You are supposed to write what will come after the pipe. For example,
if you want to count the number of lines containing STRING in the
current page:
shell grep STRING|wc -l
'!' is an useful shortcut.
!grep STRING|wc -l
subscribe
Subscribe to current page by saving it in the "subscribed" list.
If a new link is found in the page during a --sync, the new link is automatically
fetched and added to your next tour.
To unsubscribe, remove the page from the "subscribed" list.
sync
Synchronize all bookmarks lists and URLs from the to_fetch list.
- New elements in pages in subscribed lists will be added to tour
- Elements in list to_fetch will be retrieved and added to tour
- Normal lists will be synchronized and updated
- Frozen lists will be fetched only if not present.
Before a sync, you can edit the list of URLs that will be fetched with the
following command: "list edit to_fetch"
Argument : duration of cache validity (in seconds).
theme
Change the colors of your rendered text.
"theme ELEMENT COLOR"
ELEMENT is one of: window_title, window_subtitle, title,
subtitle,subsubtitle,link,oneline_link,new_link,image_link,preformatted,blockquote.
COLOR is one or many (separated by space) of: bold, faint, italic, underline, black,
red, green, yellow, blue, purple, cyan, white.
Each color can alternatively be prefaced with "bright_".
tour
Add index items as waypoints on a tour, which is basically a FIFO
queue of gemini items.
tour or t alone brings you to the next item in your tour.
Items can be added with tour 1 2 3 4 or ranges like tour 1-4.
All items in current menu can be added with tour *.
All items in $LIST can be added with tour $LIST.
Current item can be added back to the end of the tour with tour ..
Current tour can be listed with tour ls and scrubbed with tour clear.
tutorial
Access the offpunk.net tutorial (online)
up
Go up one directory in the path.
Take an integer as argument to go up multiple times.
url
Print the url of the current page.
Use "url XX" where XX is a number to print the url of link XX.
"url" can also be piped to the shell, using the pipe "|"
version
Display version and system information.
view
Run most recently visited item through "less" command, restoring previous position.
Use "view normal" to see the default article view on html page.
Use "view full" to see a complete html page instead of the article view.
Use "view XX" where XX is a number to view information about link XX.
(full, feed, feeds have no effect on non-html content).
wikipedia
Search on wikipedia using the configured Gemini interface.
The first word should be the two letters code for the language.
Exemple : "wikipedia en Gemini protocol"
But you can also use abbreviations to go faster:
"wen Gemini protocol". (your abbreviation might be missing, report the bug)
The interface used can be modified with the command:
"set wikipedia URL" where URL should contains two "%s", the first
one used for the language, the second for the search string.
xkcd
Open the specified XKCD comics (a number is required as parameter)
Greetings,
I'm learning offpunk's commands and felt the need to have a complete list instead of constantly consulting it.
I don't know if it exists somewhere, but I ran a
help <topic>for all the options available in Offpunk v2.8 and saved them in the document below (and attached).I'm sharing it in case anyone is interested.
Thank you.
offpunk-v2.8-help.md
Offpunk v2.8
help
Documented commands (type
help <topic>):========================================
To render images inline, you need either chafa >= 1.10 or timg > 1.3.2
========================================
add
Add the current URL to the list specified as argument.
If no argument given, URL is added to Bookmarks.
You can pass a link number as the second argument to add the link.
"add $LIST XX" will add link number XX to $LIST
alias
Create or modifiy an alias
alias : show all existing aliases
alias ALIAS : show the command linked to ALIAS
alias ALIAS CMD : create or replace existing ALIAS to be linked to command CMDf
archive
Archive current page by removing it from every list and adding it to
archives, which is a special historical list limited in size. It is similar to
move archives.back
Go back to the previous gemini item.
bookmarks
Show or access the bookmarks menu.
'bookmarks' shows all bookmarks.
'bookmarks n' navigates immediately to item n in the bookmark menu.
Bookmarks are stored using the 'add' command.
certs
Manage your client certificates (identities) for a site.
certswill display all valid certificates for the current sitecerts new <name> <days-valid> <url[optional]>will create a new certificate, if no url is specified, the current open site will be used.copy
Copy the content of the last visited page as gemtext/html in the clipboard.
Use with "url" as argument to only copy the adress.
Use with "raw" to copy ANSI content as seen in your terminal (with colour codes).
Use with "cache" to copy the path of the cached content.
Use with "title" to copy the title of the page.
Use with "link" to copy a link in the gemtext format to that page with the title.
exit
Exit Offpunk.
feed
Display RSS or Atom feeds linked to the current page.
find
Find in current page by displaying only relevant lines (grep).
forward
Go forward to the next gemini item.
go
Go to a gemini URL or marked item.
gus
Submit a search query to the geminispace.info search engine.
handler
View or set handler commands for different MIME types.
handler MIMETYPE : see handler for MIMETYPE
handler MIMETYPE CMD : set handler for MIMETYPE to CMD
in the CMD, %s will be replaced by the filename.
if no %s, it will be added at the end.
MIMETYPE can be the true mimetype or the file extension.
Examples:
handler application/pdf zathura %s
handler .odt lowriter
handler docx lowriter
help
ALARM! Recursion detected! ALARM! Prepare to eject!
history
Display history.
info
Display information about current page.
list
Manage list of bookmarked pages.
See also :
There’s no "delete" on purpose. The use of "archive" is recommended.
The following lists cannot be removed or frozen but can be edited with "list edit"
ls
List contents of current index.
Use 'ls -l' to see URLs.
mark
Mark the current item with a single letter. This letter can then
be passed to the 'go' command to return to the current item later.
Think of it like marks in vi: 'mark a'='ma' and 'go a'=''a'.
Marks are temporary until shutdown (not saved to disk).
move
move LIST will add the current page to the list LIST.
With a major twist: current page will be removed from all other lists.
If current page was not in a list, this command is similar to
add LIST.offline
Use Offpunk offline by only accessing cached content
online
Use Offpunk online with a direct connection
open
Open current item with the configured handler or xdg-open.
Use "open url" to open current URL in a browser.
Use "open 2 4" to open links 2 and 4
You can combine with "open url 2 4" to open URL of links
see "handler" command to set your handler.
quit
Exit Offpunk.
redirect
Display and manage the list of redirected URLs. This features is mostly useful to use privacy-friendly frontends for popular websites.
reload
Reload the current URL.
root
Go to root selector of the server hosting current item.
save
Save an item to the filesystem.
'save n filename' saves menu item n to the specified filename.
'save filename' saves the last viewed item to the specified filename.
'save n' saves menu item n to an automagic filename.
search
Search on Gemini using the engine configured (by default kennedy.gemi.dev)
You can configure it using "set search URL".
URL should contains one "%s" that will be replaced by the search term.
set
View or set various options.
shell
Send the content of the current page to the shell and pipe it.
You are supposed to write what will come after the pipe. For example,
if you want to count the number of lines containing STRING in the
current page:
subscribe
Subscribe to current page by saving it in the "subscribed" list.
If a new link is found in the page during a --sync, the new link is automatically
fetched and added to your next tour.
To unsubscribe, remove the page from the "subscribed" list.
sync
Synchronize all bookmarks lists and URLs from the to_fetch list.
Before a sync, you can edit the list of URLs that will be fetched with the
following command: "list edit to_fetch"
Argument : duration of cache validity (in seconds).
theme
Change the colors of your rendered text.
"theme ELEMENT COLOR"
ELEMENT is one of: window_title, window_subtitle, title,
subtitle,subsubtitle,link,oneline_link,new_link,image_link,preformatted,blockquote.
COLOR is one or many (separated by space) of: bold, faint, italic, underline, black,
red, green, yellow, blue, purple, cyan, white.
Each color can alternatively be prefaced with "bright_".
tour
Add index items as waypoints on a tour, which is basically a FIFO
queue of gemini items.
tourortalone brings you to the next item in your tour.Items can be added with
tour 1 2 3 4or ranges liketour 1-4.All items in current menu can be added with
tour *.All items in $LIST can be added with
tour $LIST.Current item can be added back to the end of the tour with
tour ..Current tour can be listed with
tour lsand scrubbed withtour clear.tutorial
Access the offpunk.net tutorial (online)
up
Go up one directory in the path.
Take an integer as argument to go up multiple times.
url
Print the url of the current page.
Use "url XX" where XX is a number to print the url of link XX.
"url" can also be piped to the shell, using the pipe "|"
version
Display version and system information.
view
Run most recently visited item through "less" command, restoring previous position.
Use "view normal" to see the default article view on html page.
Use "view full" to see a complete html page instead of the article view.
Use "view XX" where XX is a number to view information about link XX.
(full, feed, feeds have no effect on non-html content).
wikipedia
Search on wikipedia using the configured Gemini interface.
The first word should be the two letters code for the language.
Exemple : "wikipedia en Gemini protocol"
But you can also use abbreviations to go faster:
"wen Gemini protocol". (your abbreviation might be missing, report the bug)
The interface used can be modified with the command:
"set wikipedia URL" where URL should contains two "%s", the first
one used for the language, the second for the search string.
xkcd
Open the specified XKCD comics (a number is required as parameter)