ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Sublime​Manpage

by apophys ST2/ST3

Simple manual page "viewer".

Details

  • 3 2013.12.27.23.52.18
    2 1.0.0
  • github.​com
  • github.​com
  • 5 years ago
  • 45 minutes ago
  • 6 years ago

Installs

  • Total 2K
  • Win 593
  • OS X 780
  • Linux 792
Sep 22 Sep 21 Sep 20 Sep 19 Sep 18 Sep 17 Sep 16 Sep 15 Sep 14 Sep 13 Sep 12 Sep 11 Sep 10 Sep 9 Sep 8 Sep 7 Sep 6 Sep 5 Sep 4 Sep 3 Sep 2 Sep 1 Aug 31 Aug 30 Aug 29 Aug 28 Aug 27 Aug 26 Aug 25 Aug 24 Aug 23 Aug 22 Aug 21 Aug 20 Aug 19 Aug 18 Aug 17 Aug 16 Aug 15 Aug 14 Aug 13 Aug 12 Aug 11 Aug 10 Aug 9 Aug 8
Windows 0 0 1 0 0 0 1 1 0 0 0 1 0 0 0 0 0 0 2 0 0 1 0 0 0 0 0 0 0 0 0 1 0 0 0 0 1 0 1 0 1 0 0 0 0 1
OS X 0 0 0 1 1 0 0 0 0 1 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 1 2 0 0 0 0 0 0 0 0 0 1 0 0 0 0
Linux 1 1 0 1 0 0 1 0 0 0 0 0 0 0 1 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0 1 0 0 2 0 0 1 0 0 0 0 0 0 0 0 2

Readme

Source
raw.​githubusercontent.​com

Sublime Manpage

SublimeManpage is small plugin for calling man utility from Sublime Text 2 editor. Result is opened in new tab inside the editor.

Plugin now works also on platforms other than Linux and OS X. Though in a limited way.

Install

Install with Package Control.

Command Palette > Package Control: Install Package > SublimeManpage

Or clone this reporitory from github:

$ git clone https://apophys@github.com/apophys/SublimeManpage.git

Config

Package is shipped with default configuration prepared for C language - sections 2, 3 and 3p (system calls, function calls). In default, exact match is disabled. Exact match can be turned on/off from Command Palette.

You can edit the configuration in the user settings.

Preferences -> Package Settings -> SublimeManpage -> Settings - Default

Or

Command Palette > Preferences: SublimeManpage Settings - User

{
    "sections" : [ "2", "3", "3p"],
    "exact_match" : false
}

If you need some other sections, just append the section number to this list.

Exact match

The plugin now supports an exact match functionality. You can turn it on/off either manually or from command palette.

Usage

Use Manpage: Open manual page option, from command palette or on OS X key binding super + shift + m or key binding ctrl + alt + m on Linux. This will pop up a form in which you can write the function name.

Another possibility is to use super + alt + w or ctrl + alt + w on OS X and Linux respectively to lookup the word under the cursor directly.

If exact_match is set to true, plugin will open manpage for the first exact match in specified sections.

Windows (*) support

On windows ((*) any platform other than linux and os x), manual page is opened in web browser. The plugin currently uses www.linuxmanpages.com. In this case, plugin does not support listing matching functions but opens first exact match according to sections as defined in settings.

If functions is not found, an error message is raised.

Contributors

Levente Varga, Hector Hurtarte nirm03

License

This plugin is licensed under the MIT license.