19

I find the man page format extremely painful to write. Is there a GUI (WYSIWYG or WYSIWYM) editor available to make this task easier? I'm hoping for an application that is to man pages as Kompozer is to web pages.

I have tried gmanedit but have found that it is basically just a text editor with some easily available snippets - it is necessary to know the man page format to use it and the editing area is just a text widget.

While I'd prefer software that is in the official Ubuntu repositories, I am OK with using unsupported methods for installation such as PPAs or installing from source.

9

It is possible to author man pages using DocBook markup and use tools such as docbook2x-man to create troff output. There are some visual ("WYSIWYM"-style) editors available for editing DocBook markup. For example, the GPL-licensed Syntext Serna Free:

Screenshot of using Syntext Serna Free to edit a DocBook reference entry

Also, doclifter is a utility for converting man pages to DocBook.

  • Agreed, I write my man pages in docbook format. It's much more maintainable! – Roger Light Nov 24 '10 at 23:33
  • Docbook is the best format for creating documentation. Once your Docbook file is completed, it can be converted to a multitude of formats. XHTML, Man Pages, etc ... – J. M. Becker Oct 6 '12 at 20:42
  • Seems like a nice editor, but unfortunately it looks like there is no free version anymore. – MestreLion Nov 8 '12 at 17:11
1

This is an addendum to Jukka's suggestion of using docbook with the main reason why I like it other than it's much easier to write and deal with:

You can convert it to .pot files for more easy translation. For example, creating a .pot (language template):

xml2po -o my_program.1.pot my_program.1.xml

Then merging translated files (.po) back into a language specific docbook man page, in this case German:

xml2po -p de.po my_program.xml > my_program.de.xml

1

Grapse, an HTML5 webapp, was featured on Hacker News 2/3 of a year ago. It includes built-in preview and syntax highlighting.

  • It looks good but seems primarily for FreeBSD/OSX and doesn't format standard Linux man pages properly (e.g. loses paragraph spacing for options) even when switched to AN in top right of web page. – Cas Mar 13 '17 at 23:40
0

There is one, ManEdit. However, I don't know if its still active :(

Thanks!

  • I also found that one, it does seem to be abandoned and uses GTK 1.x! – Isaiah Nov 23 '10 at 22:04

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service, privacy policy and cookie policy

Not the answer you're looking for? Browse other questions tagged or ask your own question.