LinuxCommandLibrary

wikiman

Search and display Wikipedia articles

TLDR

Search for a specific topic in all installed sources

$ wikiman [search_term]
copy

Search for a topic in a specific [s]ource
$ wikiman -s [source] [search_term]
copy

Search for a topic in two or more specific [s]ources
$ wikiman -s [source1,source2,...] [search_term]
copy

List existing [S]ources
$ wikiman -S
copy

Display [h]elp
$ wikiman -h
copy

SYNOPSIS

wikiman [man page name]

PARAMETERS

[man page name]
    The name of the manual page to display. If omitted, wikiman may display a list of available manual pages or an error.

DESCRIPTION

The wikiman command is a tool that retrieves and displays Linux manual pages within a web browser.

It's not a standard system utility but rather a script that leverages man to format manual pages and then serves them via a lightweight HTTP server. This allows users to view the documentation in a more user-friendly format, often with better navigation and search capabilities than the command-line man. Often wikiman runs a tiny web server that serves the rendered content to your default web browser.

Note: wikiman is usually not part of the standard distribution and must be installed manually.

CAVEATS

wikiman requires a web browser to be installed and properly configured on the system. It may also depend on other tools like man, groff, and a basic HTTP server (e.g., Python's http.server).
The exact behavior and dependencies can vary depending on the specific implementation of wikiman.

IMPLEMENTATION DETAILS

wikiman often works by executing the man command to format the manual page, then using groff or a similar tool to convert the output to HTML. A simple web server is then started to serve the HTML page to the user's browser. The script usually opens the default web browser to the served address.

The precise implementation can vary significantly, from simple shell scripts using python -m http.server to more complex applications written in Python or other languages.

SEE ALSO

man(1), apropos(1), whatis(1)

Copied to clipboard