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

Sublime​Manpage

by apophys ALL

Simple manual page "viewer".

Details

  • 2013.12.27.23.52.18
    1.0.0
  • github.​com
  • github.​com
  • 11 years ago
  • 4 hours ago
  • 13 years ago

Installs

  • Total 3K
  • Win 774
  • Mac 916
  • Linux 971
Dec 3 Dec 2 Dec 1 Nov 30 Nov 29 Nov 28 Nov 27 Nov 26 Nov 25 Nov 24 Nov 23 Nov 22 Nov 21 Nov 20 Nov 19 Nov 18 Nov 17 Nov 16 Nov 15 Nov 14 Nov 13 Nov 12 Nov 11 Nov 10 Nov 9 Nov 8 Nov 7 Nov 6 Nov 5 Nov 4 Nov 3 Nov 2 Nov 1 Oct 31 Oct 30 Oct 29 Oct 28 Oct 27 Oct 26 Oct 25 Oct 24 Oct 23 Oct 22 Oct 21 Oct 20
Windows 0 0 0 0 0 0 0 0 0 0 0 0 1 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
Mac 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 2 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
Linux 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0

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.