GithubHelp home page GithubHelp logo

Comments (3)

GoogleCodeExporter avatar GoogleCodeExporter commented on June 25, 2024
The nroff man page doesn't shed much light, but
http://www.linuxfocus.org/English/November2003/article309.shtml has an informal 
intro
to man page grammar.

Vendion,
What would you like to see highlighted?
I assume nroff macros of the form .FOO and escape sequences like \-.

Are quoted string significant?  What about angle bracket strings like <foo>?

Is there any convention for commenting within a manpage?

Original comment by [email protected] on 17 Jul 2008 at 4:12

from google-code-prettify.

GoogleCodeExporter avatar GoogleCodeExporter commented on June 25, 2024
The things that would be nice to have highlighted:  I am going off of the Troff
Mandoc syntax Kwrite uses for man pages.
.TH, .SH, .B, .BI Can be one color
.TP A differnt color
Chapers like: NAME, SYNOPSIS, DESCRIPTION so one and so fourth should also be
highlighted.
\- should be once color, this causes the command arugment to be formatted bold 
font.

This is my first man page that I wrote so I can not tell you for certain if 
angle
bracket strings do anything, from what I can tell it is a way of making email
addresses and URL stick out better.  As far as I know there is no way of 
commenting
within a manpage, outside of the Google Code review system.


Quoted strings are not significant, when the man page is displayed the quotes 
are
also shown.

I have a screen shot of what my man page looks like with Troff Mandoc syntax
highlighting so you can see what I am talking about.
http://img233.imageshack.us/img233/6070/manpage1le5.png
http://img144.imageshack.us/img144/1961/manpage2bl6.png
http://img144.imageshack.us/img144/3494/manpage3qt7.png (I blurred out the email
addresses because it is hosted on a public server)

I hope I answered some of your questions here.

Original comment by vendion on 17 Jul 2008 at 1:22

from google-code-prettify.

GoogleCodeExporter avatar GoogleCodeExporter commented on June 25, 2024
Ok.  It looks like the syntax highlighting is, to some degree, dependent on the
particular macro.

Also, it looks like quoted strings are highlighted.  See 'Excludes the directory
called "music"...' in your second screenshot.

But angle-bracketed sections are not highlighted.

Original comment by [email protected] on 17 Jul 2008 at 7:02

  • Changed state: Accepted

from google-code-prettify.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.