docs: set vim filetype on man pages for syntax highlighting #5296
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
added
the
documentation
reinerh
approved these changes
Aug 5, 2022
|
merged! |
kmk3
added a commit
that referenced
this pull request
Aug 18, 2022
kmk3
added a commit
to kmk3/firejail
that referenced
this pull request
Nov 24, 2022
Ignore the following paths: - 'src/man/*.txt' - contrib/vim To avoid running CI unnecessarily. Note: build-extra essentially only builds with clang and runs linters on the C code, so changes to the man pages and vim files should not affect the result. Do not ignore them on .github/workflows/build.yml because they are part of DISTFILES (see the root Makefile). Misc: I noticed this on netblue30#5296 (man pages).
kmk3
added a commit
to kmk3/firejail
that referenced
this pull request
Nov 24, 2022
Ignore the following paths: - 'contrib/vim/**' - 'src/man/*.txt' To avoid running CI unnecessarily. Note: build-extra essentially only builds with clang and runs linters on the C code, so changes to the man pages and vim files should not affect the result. Do not ignore them on .github/workflows/build.yml because they are part of DISTFILES (see the root Makefile). Misc: I noticed this on netblue30#5296 (man pages).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
See
:help groff.vimand:help filetype.txtin (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 #5290.