https://github.com/meronz/vscode.manpages

Quickly open man pages and navigate through them.
https://github.com/meronz/vscode.manpages

linux shell vscode vscode-extension

Last synced: 21 days ago
JSON representation

Quickly open man pages and navigate through them.

• Host: GitHub
• URL: https://github.com/meronz/vscode.manpages
• Owner: meronz
• License: gpl-3.0
• Created: 2021-11-05T11:28:15.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-01-20T11:59:39.000Z (12 months ago)
• Last Synced: 2024-01-21T12:41:33.269Z (12 months ago)
• Topics: linux, shell, vscode, vscode-extension
• Language: TypeScript
• Homepage:
• Size: 243 KB
• Stars: 6
• Watchers: 2
• Forks: 4
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Manpages 

[![Deploy Extension](https://github.com/meronz/vscode.manpages/actions/workflows/publish.yml/badge.svg?branch=main)](https://github.com/meronz/vscode.manpages/actions/workflows/publish.yml)

+ Open the man page for the word under cursor or selected.

+ Move quickly by following links inside the man page.

+ Search the manual pages for names and descriptions (apropos).

## Requirements

This extension requires `man` to be installed and working from the integrated terminal.

You may configure the command to execute the man binary with the `man.path` setting 

## Configuration

The extension accepts the following configuration parameters:

setting                 | description                  | default

------------------------|------------------------------|----------

manpages.binary.path    | Path of the man binary       | man

manpages.binary.args    | Arguments passed to man      |

manpages.apropos.path   | Path of the apropos binary   | apropos

manpages.apropos.args   | Arguments passed to apropos  | 

manpages.openAsSplit    | Open the manpage result in a split tab | true

manpages.editorMenuShortcutPosition | Specifies the position of the 'Open page' command in the editor context menu | navigation

manpages.enableSyntaxHighlighting | Enable syntax highlighting for manpages | true

For example, on Windows with WSL you may use the setting `"manpages.binary.path": "wsl man"`.

Moreover, you can pass additional arguments to man, like `"--manpath=/some/path"`, `"--locale=fr"`, etc. The complete list depends on the OS, and you can find it by running `man --help`.