From mboxrd@z Thu Jan 1 00:00:00 1970 X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on inbox.vuxu.org X-Spam-Level: X-Spam-Status: No, score=0.2 required=5.0 tests=DKIM_INVALID,DKIM_SIGNED autolearn=no autolearn_force=no version=3.4.4 Received: (qmail 27774 invoked from network); 28 Oct 2022 01:44:14 -0000 Received: from bsd.lv (HELO mandoc.bsd.lv) (66.111.2.12) by inbox.vuxu.org with ESMTPUTF8; 28 Oct 2022 01:44:14 -0000 Received: from fantadrom.bsd.lv (localhost [127.0.0.1]) by mandoc.bsd.lv (OpenSMTPD) with ESMTP id a14115dc for ; Thu, 27 Oct 2022 20:44:12 -0500 (EST) Received: from mail-io1-f52.google.com (mail-io1-f52.google.com [209.85.166.52]) by mandoc.bsd.lv (OpenSMTPD) with ESMTP id 5ecc7916 for ; Thu, 27 Oct 2022 20:44:11 -0500 (EST) Received: by mail-io1-f52.google.com with SMTP id q75so3501244iod.7 for ; Thu, 27 Oct 2022 18:44:11 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=imca-cat.org; s=google; h=content-disposition:mime-version:message-id:subject:to:from:date :from:to:cc:subject:date:message-id:reply-to; bh=auv7ujDI+O1wS7pxKaHfgNi2Ie7HVQhP27cHj+Ba/Qc=; b=SHZj3xf7vVSECW+CVOaOXn54SO/t9PJ1Oh36OYCkgC+t/UatUYEUuUZUfFt05ylkML d0mGS+VVJf7IdOKQYgmpjNYD2hHckAPKGbFqJNLTN6YrwZa5YTwmIVP7/m405+BG+R++ xPiQinaPKsO4b0DDtSbJSss+GJ3jLmnSfT5Uc= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-disposition:mime-version:message-id:subject:to:from:date :x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=auv7ujDI+O1wS7pxKaHfgNi2Ie7HVQhP27cHj+Ba/Qc=; b=m8zmeSm+aC86MKNX8KG6BxudMoiKzkrXT9DmMQvnd+2zs20IXrM5ISRtz7t9UD3f3L Q7A1XP04BRJB2rvQRaZO9caDrUmAy4/T2so7iR69yJ9RgnleGFW+8wwnKsp4IoADRwQg aXfSw6abrJdlpO7g/CvjCijGrVwhIYzcpeeO+28irXrEnc8s/hGDwRcm4n4CJP0LiRG1 4OmOWxF/E+HZ8WdOZ7Lk9yQRBG+PdSdAAlRaBfZYD9ujt+9mWpZlbKt2+DWoNfC/uTGD nkn04JX9CksgBhMs9OkwNFepxpkzn/6GvssBpsD51/ginxMzlh576YnbG6zXnSjm2Loc BInA== X-Gm-Message-State: ACrzQf35CdOwLs3JF4oiV56nWt6rvzPegWrOnf6T9paK8KHvLHQE+uaM EzqHd1+2mJ4qitLhzJVbXVQnZ2ZSMSio1w== X-Google-Smtp-Source: AMsMyM7XUNVgsq09epf4b/qU+4wA6YSNVMO7uohIhVPp02cWCsE4P7KS0rjg9QPulAiFBFOUETl8ug== X-Received: by 2002:a05:6602:1594:b0:6bc:3432:7a1b with SMTP id e20-20020a056602159400b006bc34327a1bmr30775554iow.210.1666921450678; Thu, 27 Oct 2022 18:44:10 -0700 (PDT) Received: from localhost ([66.138.188.81]) by smtp.gmail.com with ESMTPSA id w5-20020a025d05000000b0037532823a17sm193343jaa.122.2022.10.27.18.44.09 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 27 Oct 2022 18:44:10 -0700 (PDT) Date: Thu, 27 Oct 2022 20:44:09 -0500 From: "J. Lewis Muir" To: tech@mandoc.bsd.lv Subject: mdoc(7) for technical docs beyond man pages? Message-ID: <20221028014409.uivgey3ghktcmsez@mail.imca-cat.org> X-Mailinglist: mandoc-tech Reply-To: tech@mandoc.bsd.lv MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline 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