vim-utils / vim-man

View and grep man pages in vim
247 stars 32 forks source link

Program options and Synopsis syntax #19

Closed alx741 closed 9 years ago

alx741 commented 9 years ago

Result: $ viman 1 grep

Result

bruno- commented 9 years ago

Hey, options syntax highlighting is already present in the original man.vim that comes with vim. It was removed from this plugin because it's buggy (it was highlighting parts of text that shouldn't be highlighted, and not highlighting when it should). I'm sure you'll find bugs if you look into more man pages.

So far, I'd rather NOT implement this, instead of making a buggy implementation.

As for the SYNOPSIS section highlighting, the contribution for this is welcome, but it's not so trivial. We probably wanna ensure 2 things for start:

You can see how this is currently done for synopsis for manpages in sections 2 and 3, synopsis part link.

Don't get discouraged if you find this complex. Feel free to ask questions! I'd like to have this feature.

alx741 commented 9 years ago

Oh! I see. I didn't take a look of the default man.vim of vim, but what I see first is that it does not fully consider all double hyphen arguments and arguments in, for example, the synopsis section or in the middle of the text (when options are referenced in the description of other ones), and not really sure yet if there are man pages (or sections) where the options syntax will be not necessary or bad. I would like to work on this and I'll try a new pull request if got a new tentative.