ZFS handbook project patch

Warren Block wblock at wonkity.com
Thu Feb 20 14:57:55 UTC 2014


On Thu, 20 Feb 2014, Hiroki Sato wrote:

> Allan Jude <freebsd at allanjude.com> wrote
>  in <5305A9A4.1010603 at allanjude.com>:
>
> fr> It also fixes a paragraph that someone else wrote, that Warren had
> fr> pointed out made no sense.
> fr>
> fr> Also adds some missing <acronym> tags, and replace all of the
> fr> <userinput> tags that are actually commands with <command>
>
> -    <screen>&prompt.root; <userinput>service zfs start</userinput></screen>
> +    <screen>&prompt.root; <command>service zfs start</command></screen>
>
> <userinput> is correct here.  <command> is for the name of an
> executable program or command, not a command line.

Yes.  Although <command> is sometimes used for short inline commands 
that are a bit more than a simple command name:

   <para>Files beginning with the letter "A" can be listed with
     <command>ls A*</command>.  More detailed searches can be done with
     <command>find</command>:</para>

   <screen>&prompt.user; <userinput>find /usr/ports -name Makefile</userinput></screen>

There are some examples in the FDP Primer:
http://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/book.html#idp66516784

(Although they also show <prompt>, which I don't recall seeing used 
anywhere else in our docs and am pretty sure I've never used myself.)


More information about the freebsd-doc mailing list