Offpunk Commands: Your Static Manual Guide
Offpunk Commands: Your Static Manual Guide
Hey there, fellow Offpunk enthusiasts! 👋 Ever felt lost in the vastness of the Gemini space, fumbling with Offpunk commands? You're not alone! I've been there too. Navigating the command-line interface can be like exploring a new galaxy – exciting, but sometimes confusing. That's why I put together this guide – a static manual, if you will, to help you understand and master Offpunk. Think of it as your trusty companion on your Offpunk journey. Let's dive in, guys!
Accessing and Understanding Offpunk Commands
First off, let's address the elephant in the room: where's the official manual? Well, it's not exactly a single, downloadable PDF, but rather a dynamic system of help commands. This guide is based on the output of help <topic> for each available command in Offpunk v2.8, so you can easily reference and quickly execute the desired commands. Ready?
Mastering the Core Commands of Offpunk
add Command: Your Bookmark's Best Friend
Adding URLs to your bookmarks is a breeze. The add command, by default, adds the current URL to your Bookmarks list. If you want to add the URL to a specific list, just use add $LIST. For example, add my_reading_list will add the current page to a list named "my_reading_list". You can also add a specific link from the current page to a list using add $LIST XX, where XX is the link number.
alias Command: Shortcuts for Your Gemini Life
Tired of typing long commands? The alias command is your friend! This command allows you to create custom shortcuts. alias ALIAS CMD creates an alias. For example, alias g go would create an alias so you can type g instead of go. You can view all existing aliases by just typing alias.
archive Command: Tidy Up Your Online Space
The archive command helps you declutter your current list. This command removes the current page from every list and then adds it to the "archives" list. Think of it as moving a file to a special, historical storage, limiting its size.
back & forward Commands: Navigating the Gemini Web
Pretty straightforward, these two commands do exactly what you think: back takes you to the previous page, and forward takes you to the next one in your browsing history.
bookmarks Command: Your Personal Web Library
The bookmarks command allows you to manage your bookmarked pages, which are stored using the add command. Typing bookmarks displays all of your saved bookmarks. Then, bookmarks n immediately takes you to item number 'n' on your bookmarks menu.
certs Command: Secure Your Connections
This command allows you to manage the client certificates (identities) you use to connect to Gemini servers. Typing certs will display all of the valid certificates for the current site. certs new <name> <days-valid> <url[optional]> will create a new certificate for you to use. If you do not specify a URL, it will use the current site you are on.
copy Command: Get the Content You Need
The copy command copies the content of the current page to your clipboard. You can specify different arguments to grab specific items. copy url will grab just the address, copy raw copies the ANSI content, copy cache will grab the path of the cached content, copy title will copy the page title, and copy link will format the current page as a gemtext link.
exit & quit Commands: Ending Your Offpunk Session
Simple, yet crucial. These commands gracefully end your Offpunk session.
feed Command: Stay Updated
This will display any RSS or Atom feeds linked to the current page. Keep up with the latest content with ease.
find Command: Finding What You Need
This command allows you to search the current page for a specific string, displaying only the relevant lines (similar to grep).
go Command: Navigating the Gemini Universe
The go command is your go-to for navigating. You can go to a gemini URL or a marked item.
gus Command: GeminiSpace Search
Search the geminispace.info search engine.
handler Command: Managing File Types
This command lets you set custom commands to handle different MIME types or file extensions. For instance, handler application/pdf zathura %s will open PDF files with Zathura. The %s is replaced with the filename.
help Command: Your Offpunk Guide
Typing help by itself gives you a list of all available commands. Using help <command> gives you detailed information on the specific command.
history Command: Revisiting Your Past
Display a list of the pages you have visited.
info Command: Unveiling Page Details
Displays information about the current page, such as its URL, and any metadata.
list Command: Managing Bookmarked Pages
Manage your lists of bookmarked pages. This lets you create, edit, delete, and subscribe to lists. Type list to see your available lists. list create $NEWLIST creates a new list. list edit $LIST allows you to edit the list. list delete $LIST deletes a list permanently (and needs confirmation). The add command adds pages to a list, and the move command moves a page to a list, removing it from all other lists.
ls Command: Listing Content
List the contents of the current index. Use ls -l to see the URLs.
mark Command: Your Personal Markers
Mark the current item with a single letter. Later, you can use the go command with that letter to return to the marked item (like marks in vi).
move Command: Change List, Remove Old
Move the current page to the specified list and remove it from all other lists. Similar to archive but puts it in the specified list.
offline Command: Offline Access
Use Offpunk offline, accessing only cached content.
online Command: Direct Connection
Use Offpunk online, connecting directly to the Gemini space.
open Command: Open with Handlers
Opens the current item with the configured handler, or xdg-open. Use open url to open the current URL in a browser. See the handler command to configure your handlers.
redirect Command: Manage URL Redirects
Displays and manages the list of redirected URLs. This is particularly useful for privacy-friendly frontends.
reload Command: Refresh Your View
Reloads the current URL.
root Command: Back to the Source
Goes to the root selector of the server hosting the current item.
save Command: Save Items
Save an item to your 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 Command: Searching the Gemini Space
Search on Gemini using the configured search engine, which defaults to kennedy.gemi.dev. You can configure the search engine with the set search URL command.
set Command: Configure Your Offpunk Experience
View or set various options related to your Offpunk environment.
shell Command: Execute Shell Commands
Send the content of the current page to the shell and pipe it. Use ! as a shortcut. For example, shell grep STRING|wc -l to count lines containing a specific string.
subscribe Command: Stay in the Loop
Subscribe to the current page, saving it to the "subscribed" list. Any new links found in the page will be automatically fetched during the next sync and added to your tour. To unsubscribe, just remove the page from the "subscribed" list.
sync Command: Synchronize Your Lists
Synchronizes all your bookmark lists and URLs from your to_fetch list. New links in subscribed lists get added to your tour. Elements in the to_fetch list are retrieved and added to your tour. Normal lists are synchronized and updated. Frozen lists are fetched only if not already present. You can edit the URLs that will be fetched before a sync using "list edit to_fetch". You can also provide an argument, which is the duration of cache validity (in seconds).
theme Command: Customize Your Colors
Change the colors of the rendered text. You can change the element (window_title, title, etc.) and the color (bold, red, etc.).
tour Command: Your Gemini Journey
Add items as waypoints to create a tour, a FIFO queue of Gemini items. tour or t alone goes to the next item. tour 1 2 3 4 adds items 1 through 4. tour * adds all items in the current menu. tour $LIST adds all items in a list. tour . adds the current item back to the end. tour ls lists your tour. tour clear clears your tour.
tutorial Command: Learn the Ropes
Access the offpunk.net tutorial (online).
up Command: Navigate Directories
Go up one directory in the path. You can provide a number argument to go up multiple times.
url Command: Show the URL
Print the URL of the current page. url XX will print the URL of link XX. The URL can be piped to the shell.
version Command: Check Your Version
Display version and system information.
view Command: View Page Content
View the most recently visited item using the "less" command, preserving the previous position. Use view normal to see the default article view for HTML pages. view full to see the complete HTML page. view XX to view information about link XX. Has no effect on non-HTML content.
wikipedia Command: Wikipedia Search
Search on Wikipedia using the configured Gemini interface. Use wikipedia en Gemini protocol for English searches. You can also use abbreviations, such as wen Gemini protocol.
xkcd Command: XKCD Comics
Open a specific XKCD comic by its number.
In Conclusion
So, there you have it, folks! A comprehensive (hopefully!) guide to the commands of Offpunk v2.8. This isn't just a list; it's a starting point for exploring the Gemini space with confidence. Remember to experiment, have fun, and don't be afraid to dive in! Happy browsing! 🚀