tech@mandoc.bsd.lv
 help / color / mirror / Atom feed
* mdoc(7) for technical docs beyond man pages?
@ 2022-10-28  1:44 J. Lewis Muir
  0 siblings, 0 replies; only message in thread
From: J. Lewis Muir @ 2022-10-28  1:44 UTC (permalink / raw)
  To: tech

Hello!

(I tried subscribing to the discuss@ mailing list twice over the past
few weeks thinking that it would be the better place to post this
message, but I was never approved by the gatekeepers, so posting here
instead.)

Is mdoc(7) intended for all technical documentation, or just man pages?

I came across the article "docbook2mdoc-1.0.0 released" from 2019

  https://undeadly.org/cgi?action=article&sid=20190419101505

and was surprised to read this paragraph:

  DocBook intends to provide authors of technical documentation, in
  particular about computer software, with a system of semantic markup.
  So far, that's an excellent idea.  It's exactly the same goal which
  the mdoc(7) language pursues, too.

Up until now, I had thought that mdoc(7) was intended for man pages
only, but the above article seems to suggest not.  For example, would
it be within the intended purpose to write large technical documents in
mdoc(7) such as the NetBSD Guide

  https://netbsd.org/docs/guide/en/index.html

the PostgreSQL Documentation

  https://www.postgresql.org/docs/current/index.html

(both of which are written in DocBook), or Practical UNIX Manuals: mdoc

  https://manpages.bsd.lv/mdoc.html

(which is written in HTML)?  If so, are there tools for generating such
documentation from mdoc(7)?

Thank you!

Lewis
--
 To unsubscribe send an email to tech+unsubscribe@mandoc.bsd.lv


^ permalink raw reply	[flat|nested] only message in thread

only message in thread, other threads:[~2022-10-28  1:44 UTC | newest]

Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-10-28  1:44 mdoc(7) for technical docs beyond man pages? J. Lewis Muir

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).