Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: set vim filetype on man pages for syntax highlighting #5296

Merged
merged 1 commit into from
Aug 14, 2022

Commits on Aug 5, 2022

  1. docs: set vim filetype on man pages for syntax highlighting

    Since the man pages in src/man use a ".txt" file extension (rather than
    ".1" or ".5"), their filetype is detected by (neo)vim as "text".
    
    So at the bottom of every man page, add a vim modeline in a comment and
    set the filetype to "groff", to enable syntax highlighting.
    
    Note: All of the generated ".man", ".1" and ".5" files are currently
    being detected as "nroff".
    
    Note2: Set the filetype to "groff" rather than "nroff" because at least
    .UR and .UE are groff extensions.  These macros look the same with
    either filetype, but there may be more extensions being used and the
    nroff.vim syntax file (which is included by groff.vim) does things
    differently based on which filetype is used.
    
    Based on the following example from (neo)vim's filetype.txt:
    
        or add this modeline to the file:
                /* vim: set filetype=idl : */
    
    See `:help groff.vim` and `:help filetype.txt` in (neo)vim.
    
    See also groff_man(7) for the man page macros (including extensions).
    
    Environment: neovim 0.7.2-3 on Artix Linux.
    
    Misc: I noticed this on netblue30#5290.
    kmk3 committed Aug 5, 2022
    Configuration menu
    Copy the full SHA
    aacd2e7 View commit details
    Browse the repository at this point in the history