A Neovim plugin that integrates man pages with Telescope, allowing you to quickly search and preview man pages without leaving your editor.
- Fuzzy search man pages using Telescope
- Preview man pages directly in Telescope
- Quick access with customizable keybindings
- Browse all available man pages
- Direct search by name
- Neovim >= 0.7
- telescope.nvim
- Unix-like system with
man
command available
Using lazy.nvim
{
"quiet-ghost/man-pages.nvim",
dependencies = {
"nvim-telescope/telescope.nvim",
},
config = function()
require("man-pages").setup({
keymaps = {
search = "<leader>mp", -- Search for a specific man page
browse = "<leader>mb", -- Browse all man pages
},
})
end,
}
Using packer.nvim
use {
"quiet-ghost/man-pages.nvim",
requires = {
"nvim-telescope/telescope.nvim",
},
config = function()
require("man-pages").setup()
end
}
<leader>mp
- Search for man pages (type to filter)<leader>mb
- Browse all available man pages
:ManSearch [name]
- Search for a man page by name:ManBrowse
- Browse all available man pages
- Press
<leader>mp
to open the search prompt - Type the name of the command/function you want documentation for
- If exact match is found, it opens directly
- If multiple matches, select from Telescope picker
- Preview appears automatically in Telescope
- Press
<Enter>
to open the full man page in Neovim
require("man-pages").setup({
keymaps = {
search = "<leader>mp", -- Set to false to disable
browse = "<leader>mb", -- Set to false to disable
},
})
The plugin:
- Uses the system's
man -k
command to get available man pages - Integrates with Telescope for fuzzy finding
- Formats man page output for clean preview
- Opens selected pages using Neovim's built-in
:Man
command