nvim_runtime_lua

man

Methods9 

function M._match_manpage_path(paths: string[] | nil, name: nil | string, sect: nil | string) -> any

Given an array of paths returned by man -w, find the correct path for the given name and section.

function M._find_path(name: nil | string, sect: nil | string) -> path nil | string

Attempts to find the path to a manpage based on the passed section and name.

  1. If manpage could not be found with the given sect and name,

    2. then try all the sections in b:mandefaultsects.

  2. If it still could not be found, then we try again without a section.
  3. If still not found but $MANSECT is set, then we try again with $MANSECT

    4. unset.

  4. If a path still wasn't found, return nil.
function M.man_complete(arg_lead: string, cmd_line: string) -> table | nil | string[]
 
function M.goto_tag(pattern: string, _, _) -> { cmd: string, filename: string, name: string }[]
 
function M.init_pager() -> nil

Called when Nvim is invoked as $MANPAGER.

function M.open_page(count: integer, smods, args: string[]) -> err nil | string
 
function M.read_page(ref) -> err nil | string

Called when a man:// buffer is opened.

function M.refresh_page() -> err nil | string
 
function M.show_toc() -> nil