Date: Fri, 8 Mar 2024 21:24:54 +0000 From: Christopher Davidson <christopher.davidson@gmail.com> To: Alexander Ziaee <concussious@runbox.com>, freebsd-doc <freebsd-doc@FreeBSD.org> Subject: Re: Question relationship of builting(1) and functions refrenced through .Xr Message-ID: <BN0PR20MB37501679FEEF7C3772505796A2272@BN0PR20MB3750.namprd20.prod.outlook.com> In-Reply-To: <E1rigqB-0003rA-NL@rmmprod07.runbox>
index | next in thread | previous in thread | raw e-mail
[-- Attachment #1 --] Hi Alexander, That does give some clarity and do appreciate it. It looks like info(1) needs to go as a link.. I will submit a pull request. But this brings me to a larger question/possible issue: Is there a way to coordinate manual page updates? I see a lot of effort and guidance on the documentation portion but not manual pages. Kind Regards, Chris From: owner-freebsd-doc@freebsd.org <owner-freebsd-doc@freebsd.org> on behalf of Alexander Ziaee <concussious@runbox.com> Date: Friday, March 8, 2024 at 3:29 PM To: freebsd-doc <freebsd-doc@FreeBSD.org> Subject: Re: Question relationship of builting(1) and functions refrenced through .Xr Hi, (Chris Davidson asked) > How does the manual page relationship work > between the builtin(1) manual pages and the > individual .Xr links to other pages Builtin(1) describes shell builtin commands, but the links in this see also section refer to: - pages for valid, discrete programs in the base system with identical names to these builtin commands - the shells supplying the builtin commands - the link that you are looking for, info(1), which we had until FreeBSD 11 [0] and can probably be removed For example, I have a shell builtin 'which' and I also have a '/usr/bin/which'. I investigate suspicious links with that command and whereis(1), but I feel like I need to at least glance over the pages or it gets too meta. [0] https://man-dev.freebsd.org/FreeBSD-10.0-RELEASE/info.1 Hope this helps! Alexander Ziaee [-- Attachment #2 --] <html xmlns:o="urn:schemas-microsoft-com:office:office" xmlns:w="urn:schemas-microsoft-com:office:word" xmlns:m="http://schemas.microsoft.com/office/2004/12/omml" xmlns="http://www.w3.org/TR/REC-html40">; <head> <meta http-equiv="Content-Type" content="text/html; charset=us-ascii"> <meta name="Generator" content="Microsoft Word 15 (filtered medium)"> <style><!-- /* Font Definitions */ @font-face {font-family:"Cambria Math"; panose-1:2 4 5 3 5 4 6 3 2 4;} @font-face {font-family:Aptos; panose-1:2 11 0 4 2 2 2 2 2 4;} /* Style Definitions */ p.MsoNormal, li.MsoNormal, div.MsoNormal {margin:0in; font-size:12.0pt; font-family:"Aptos",sans-serif;} a:link, span.MsoHyperlink {mso-style-priority:99; color:blue; text-decoration:underline;} span.EmailStyle19 {mso-style-type:personal-reply; font-family:"Aptos",sans-serif; color:windowtext;} .MsoChpDefault {mso-style-type:export-only; font-size:10.0pt; mso-ligatures:none;} @page WordSection1 {size:8.5in 11.0in; margin:1.0in 1.0in 1.0in 1.0in;} div.WordSection1 {page:WordSection1;} --></style> </head> <body lang="EN-US" link="blue" vlink="purple" style="word-wrap:break-word"> <div class="WordSection1"> <p class="MsoNormal"><span style="font-size:11.0pt">Hi Alexander,<o:p></o:p></span></p> <p class="MsoNormal"><span style="font-size:11.0pt"><o:p> </o:p></span></p> <p class="MsoNormal"><span style="font-size:11.0pt">That does give some clarity and do appreciate it. <o:p></o:p></span></p> <p class="MsoNormal"><span style="font-size:11.0pt"><o:p> </o:p></span></p> <p class="MsoNormal"><span style="font-size:11.0pt">It looks like info(1) needs to go as a link.. I will submit a pull request. <o:p></o:p></span></p> <p class="MsoNormal"><span style="font-size:11.0pt"><o:p> </o:p></span></p> <p class="MsoNormal"><span style="font-size:11.0pt">But this brings me to a larger question/possible issue: Is there a way to coordinate manual page updates?<o:p></o:p></span></p> <p class="MsoNormal"><span style="font-size:11.0pt"><o:p> </o:p></span></p> <p class="MsoNormal"><span style="font-size:11.0pt">I see a lot of effort and guidance on the documentation portion but not manual pages.<o:p></o:p></span></p> <p class="MsoNormal"><span style="font-size:11.0pt"><o:p> </o:p></span></p> <p class="MsoNormal"><span style="font-size:11.0pt">Kind Regards,<o:p></o:p></span></p> <p class="MsoNormal"><span style="font-size:11.0pt">Chris<o:p></o:p></span></p> <p class="MsoNormal"><span style="font-size:11.0pt"><o:p> </o:p></span></p> <div id="mail-editor-reference-message-container"> <div> <div style="border:none;border-top:solid #B5C4DF 1.0pt;padding:3.0pt 0in 0in 0in"> <p class="MsoNormal" style="margin-bottom:12.0pt"><b><span style="color:black">From: </span></b><span style="color:black">owner-freebsd-doc@freebsd.org <owner-freebsd-doc@freebsd.org> on behalf of Alexander Ziaee <concussious@runbox.com><br> <b>Date: </b>Friday, March 8, 2024 at 3:29 PM<br> <b>To: </b>freebsd-doc <freebsd-doc@FreeBSD.org><br> <b>Subject: </b>Re: Question relationship of builting(1) and functions refrenced through .Xr<o:p></o:p></span></p> </div> <div> <p class="MsoNormal"><span style="font-size:11.0pt">Hi,<br> <br> (Chris Davidson asked)<br> > How does the manual page relationship work<br> > between the builtin(1) manual pages and the<br> > individual .Xr links to other pages<br> <br> Builtin(1) describes shell builtin commands,<br> but the links in this see also section refer to:<br> <br> - pages for valid, discrete programs in the base<br> system with identical names to these builtin commands<br> <br> - the shells supplying the builtin commands<br> <br> - the link that you are looking for, info(1), which we had<br> until FreeBSD 11 [0] and can probably be removed<br> <br> For example, I have a shell builtin 'which' and I also<br> have a '/usr/bin/which'. I investigate suspicious links<br> with that command and whereis(1), but I feel like I need<br> to at least glance over the pages or it gets too meta.<br> <br> [0] <a href="https://man-dev.freebsd.org/FreeBSD-10.0-RELEASE/info.1">https://man-dev.freebsd.org/FreeBSD-10.0-RELEASE/info.1</a><br>; <br> Hope this helps!<br> Alexander Ziaee<o:p></o:p></span></p> </div> </div> </div> </div> </body> </html>home | help
Want to link to this message? Use this
URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?BN0PR20MB37501679FEEF7C3772505796A2272>