ArchWiki Offline Access Script

ArchWiki Offline Access Script is a powerful tool to fetch and search the ArchWiki documentation offline right from your terminal. It relies on the arch-wiki-docs package to provide you with a seamless experience of browsing and troubleshooting Arch Linux related topics.

Features

• Offline Access: Browse ArchWiki documentation without requiring an active internet connection.

• Flexible Display Modes: Choose between rofi, dmenu, or fzf for listing and selecting ArchWiki topics.

• Customizable Opening Method: Open links using xdg-open, firefox, chromium, w3m, or your preferred application. Absolutely, here's the revised installation section with the "manual" method included:

Installation

Manual Installation

1. Install the arch-wiki-docs package using your package manager:

yay -S arch-wiki-docs

3. Clone this repository:

   git clone https://github.com/niksingh710/archwiki-offline.git
   cd archwiki-offline
   

4. Make the script executable:

   chmod +x archwiki
   

Using AUR Package (Recommended)

1. Install the archwiki-offline package from AUR:

   yay -S archwiki-offline
   

Using the AUR package is the recommended method as it takes care of dependencies and provides a smoother installation experience.

Usage

./archwiki [FLAGS]

Flags:

• -h: Display help information.
• -m MODE: Select the display mode (rofi, dmenu, or fzf).
• -o OPENER: Specify the opening method for links (xdg-open, firefox, chromium, w3m, etc.). Default is xdg-open.

Tips

Example with fzf

For a seamless experience with fzf, consider creating a wrapper script that formats the page titles for better readability and uses w3m to display a preview of the selected page:

#!/bin/bash

# Custom script for using fzf with ArchWiki offline access
# Replaces spaces in the selected topic with underscores and opens the corresponding HTML file in w3m for preview

# Usage: ./fzf_archwiki.sh "Selected ArchWiki Topic"

# Replace spaces with underscores
selected_topic=$(echo "$1" | sed 's/ /_/g')

# Open the HTML file using w3m for preview
w3m /usr/share/doc/arch-wiki/html/en/$selected_topic.html

You can save this script as fzf_archwiki.sh, make it executable (chmod +x fzf_archwiki.sh), and use it along with your main script. Here's how you can use it:

./archwiki -m fzf --preview './fzf_archwiki.sh {}'

With this script, the selected ArchWiki topic will be passed to the fzf_archwiki.sh script, which will replace spaces with underscores and open the corresponding HTML file using w3m for a preview.

Remember to adjust file paths and names according to your actual setup if needed. This will allow you to preview the selected topic in the terminal itself before opening it in your browser.

Contribution

Feel free to contribute to this script by opening issues or submitting pull requests on the GitHub repository. Your contributions will be highly appreciated.

License

This project is licensed under the GPL License.