Skip to content

Repository files navigation

VSCode Manpages Syntax Extension

screenshot using Monokai dimmed

OpenSSF Best Practices

manpage adds syntax highlighting for Unix/Linux manual pages (roff/man macros) in Visual Studio Code. It helps you read and edit .man, .manpage, and section files (.1.8) with clearer structure for titles, headings, macros, and comments.

Quick start

See docs/QUICKSTART.md for a one-minute install-and-try path.

Install

From the Marketplace

  1. Open VS Code Quick Open (Ctrl+P / Cmd+P).
  2. Paste and run:
ext install CompilouIT.manpage

Or install from the Visual Studio Marketplace.

From source (development)

git clone https://github.com/jmurowaniecki/manpages.git
cd manpages
npm install

Then open the folder in VS Code (FileOpen Folder) and press F5 to launch an Extension Development Host, or symlink/copy the repo into your VS Code extensions directory.

Use

Open any man-page source file (for example foo.1 or bar.man). VS Code should select the manpage language automatically from the file extension. You can also choose manpage from the language mode picker in the status bar.

File associations, language configuration, and TextMate scopes are documented in docs/INTERFACE.md.

Feedback and contributions

Documentation

Doc Purpose
docs/QUICKSTART.md Fast path for new users
docs/INTERFACE.md External interface (extensions, scopes)
docs/ARCHITECTURE.md High-level design
docs/ROADMAP.md Plans for the next year
docs/ASSURANCE-CASE.md Security requirements and threat model
docs/SIGNED-RELEASES.md How to verify releases

Achievements

Secure use

This extension only provides TextMate grammar and language configuration for editor highlighting. It does not execute man-page content, run shell commands, or contact the network. Treat untrusted .man files like any other untrusted text: open them only when you intend to review or edit them.

Changelog

See CHANGELOG.md for release notes.

Learn more about man pages

License

Licensed under the MIT License.

Releases

Packages

Used by

Contributors

Languages