From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-io1-f46.google.com (mail-io1-f46.google.com [209.85.166.46]) by fantadrom.bsd.lv (OpenSMTPD) with ESMTP id b1fc85fa for ; Fri, 14 Jun 2019 04:24:36 -0500 (EST) Received: by mail-io1-f46.google.com with SMTP id n5so4236907ioc.7 for ; Fri, 14 Jun 2019 02:24:36 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=mime-version:references:in-reply-to:from:date:message-id:subject:to; bh=Yv6UWblOpOqUIRl87aDIPkTzwBjOisBTYEjBQkc+5/I=; b=o9k/HaC/JTk5bLthaQctXqedW3d3vG/eY4FsVON7n9LT0p/Rw2wUqnLOBOmOFmnkAS WuuWGCUnXd1RzUbTxVcajWOuUgRmCMrW776WN51lp8+YYgdTgeVMkEUAmna8IdnUm0GK rNh7SmvrtKq9Cm0KvohRGqKkvaq9KqJBWYbgZBEz0G5YsUFuNm2qCdNQfh7XlA/EQqPS KJyYbiHwO+N3grzyLomAkQOBpSeI/iUezyXV7wPDYMwlZ8u0aD3gUwRTJj5LUNK1y+/C D7P980QVv39/9EVZyRTWOlS/iAbb4QguhPdjh8jdxiztO2f93nX9uSIkHtZBlAJ+ufzr CBoA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to; bh=Yv6UWblOpOqUIRl87aDIPkTzwBjOisBTYEjBQkc+5/I=; b=TgppvRNLPHHWmds2WYwWqjFaw1Nxd0UcCYlO1V+wKBA5B81w9iP0kHqSbMmL0Dxvhs uBu1yS8mPDddDcjGwIwswTdfgJvWLw5RXtK+HcK0S3mXV3Edc+HglsD3qn4O4jsOqMN1 1fARhSQp8KeguNfV+SvaTXI+XeSqbNTszv5cKioJ6aB3tE+CpjWcWGEP/VfLxloicPud qjCLycFIdTF1N8zOWMMXH4tHSZVTsuqegm2XGhYvK3JzIe/zA8w7zMijEmp5GuDxiKRz 1uXtlY0XzFbfkgw0BJ5JRhJDd5Id2dLvzaRFuf2kB4U6XajaVeaLBiPwLsvHgLiZwafu DtCA== X-Gm-Message-State: APjAAAWUryfd6cD2UECwINvqztiyKNMNnEUHriETwi0NyJOL6g9Rp9I5 W9SV3YeyNzFtemnMYBA7zK4ctIFEQN7V768m57MJ3w== X-Google-Smtp-Source: APXvYqyR4ZyWls4vppIDfDCckE3xKr57gFo7fptCDs8knI6hB0x6aHmkhoBzcqF/0gKQB6L/H+Xztl9d6GpCLaW6fXw= X-Received: by 2002:a02:5b88:: with SMTP id g130mr65637099jab.16.1560504275502; Fri, 14 Jun 2019 02:24:35 -0700 (PDT) X-Mailinglist: mandoc-discuss Reply-To: discuss@mandoc.bsd.lv MIME-Version: 1.0 References: <20190614084313.GA17405@www.stare.cz> <20190614085423.GC17405@www.stare.cz> In-Reply-To: <20190614085423.GC17405@www.stare.cz> From: Matthew Singletary Date: Fri, 14 Jun 2019 05:24:23 -0400 Message-ID: Subject: Re: Mandoc for oil To: discuss@mandoc.bsd.lv Content-Type: multipart/alternative; boundary="000000000000030c24058b453790" --000000000000030c24058b453790 Content-Type: text/plain; charset="UTF-8" Jan, Thanks for the reply. I was concerned that if I wrote osh.1 in mdoc(7), I would need to generate another man(7) page for systems that don't support mdoc(7), ie most linuxes. But isn't the point of mandoc -T man to output man(7) from an mdoc(7) file?t don't Or asking another way; what's the most reasonable (workflow) way to write a man page in mdoc(7), but make man pages available on systems that don't support mdoc(7) (ie most linuxes)? Sorry if I'm being unclear and thanks for your help. On Fri, Jun 14, 2019 at 4:54 AM Jan Stary wrote: > > mdoc(5) is just a format; > > I mean mdoc(7), sorry. > > > A good start is > > > > $ wc -l /usr/share/man/man1/*.1 | sort -n | less > > > > (or wherever your system keeps manpages), > > pick the shortest one for a program you know and use, > > and read the (input) manpage, such as > > > > $ vim /usr/share/man/man1/yes.1 > > I forgot an important thing: on many systems outside of the *BSD family, > the system manpages will be written in the legacy man(7) format, > built on top of roff(7), a general purpose typesetting language. > > Both man(1) and mandoc(1) can read both; but mdoc(5) ficilitates > semantic markup ("this is a commandline option"), as opposed to > low-level formating instructions ("type this in italic"). > > In case your system uses man(7), not mdoc(7), as e.g. most linuxes do, > you will have to learn mdoc elsewhere, e.g. > > http://cvsweb.openbsd.org/src/usr.bin/yes/yes.1 > > Jan > > -- > To unsubscribe send an email to discuss+unsubscribe@mandoc.bsd.lv > > --000000000000030c24058b453790 Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable
Jan,
=C2=A0Thanks for the reply.
= =C2=A0 I was concerned that if I wrote osh.1 in mdoc(7), I would need to ge= nerate another man(7) page for systems that don't support mdoc(7), ie m= ost linuxes. But isn't the point of mandoc -T man to output man(7) from= an mdoc(7) file?t don't
=C2=A0 Or asking another way; w= hat's the most reasonable (workflow) way to write a man page in mdoc(7)= , but make man pages available on systems that don't support mdoc(7) (i= e most linuxes)?

=C2=A0Sorry if I'm being uncl= ear and thanks for your help.



=
On Fri, Ju= n 14, 2019 at 4:54 AM Jan Stary <hans@s= tare.cz> wrote:
> mdoc(5) is just a format;

I mean mdoc(7), sorry.

> A good start is
>
>=C2=A0 =C2=A0 =C2=A0 =C2=A0$ wc -l /usr/share/man/man1/*.1 | sort -n | = less
>
> (or wherever your system keeps manpages),
> pick the shortest one for a program you know and use,
> and read the (input) manpage, such as
>
>=C2=A0 =C2=A0 =C2=A0 =C2=A0$ vim /usr/share/man/man1/yes.1

I forgot an important thing: on many systems outside of the *BSD family, the system manpages will be written in the legacy man(7) format,
built on top of roff(7), a general purpose typesetting language.

Both man(1) and mandoc(1) can read both; but mdoc(5) ficilitates
semantic markup ("this is a commandline option"), as opposed to low-level formating instructions ("type this in italic").

In case your system uses man(7), not mdoc(7), as e.g. most linuxes do,
you will have to learn mdoc elsewhere, e.g.

=C2=A0 =C2=A0 =C2=A0 =C2=A0 http://cvsweb.openbsd.org= /src/usr.bin/yes/yes.1

Jan

--
=C2=A0To unsubscribe send an email to discuss+unsubscribe@mandoc.bsd.lv
--000000000000030c24058b453790-- -- To unsubscribe send an email to discuss+unsubscribe@mandoc.bsd.lv