From owner-freebsd-doc@FreeBSD.ORG  Thu Jul 25 18:15:44 2013
Return-Path: <owner-freebsd-doc@FreeBSD.ORG>
Delivered-To: doc@FreeBSD.org
Received: from mx1.freebsd.org (mx1.freebsd.org
 [IPv6:2001:1900:2254:206a::19:1])
 (using TLSv1 with cipher ADH-AES256-SHA (256/256 bits))
 (No client certificate requested)
 by hub.freebsd.org (Postfix) with ESMTP id C77F0217
 for <doc@FreeBSD.org>; Thu, 25 Jul 2013 18:15:44 +0000 (UTC)
 (envelope-from wblock@wonkity.com)
Received: from wonkity.com (wonkity.com [67.158.26.137])
 (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits))
 (No client certificate requested)
 by mx1.freebsd.org (Postfix) with ESMTPS id 796D227F9
 for <doc@FreeBSD.org>; Thu, 25 Jul 2013 18:15:44 +0000 (UTC)
Received: from wonkity.com (localhost [127.0.0.1])
 by wonkity.com (8.14.7/8.14.7) with ESMTP id r6PIFaEF013184
 for <doc@FreeBSD.org>; Thu, 25 Jul 2013 12:15:36 -0600 (MDT)
 (envelope-from wblock@wonkity.com)
Received: from localhost (wblock@localhost)
 by wonkity.com (8.14.7/8.14.7/Submit) with ESMTP id r6PIFa2h013181
 for <doc@FreeBSD.org>; Thu, 25 Jul 2013 12:15:36 -0600 (MDT)
 (envelope-from wblock@wonkity.com)
Date: Thu, 25 Jul 2013 12:15:36 -0600 (MDT)
From: Warren Block <wblock@wonkity.com>
To: doc@FreeBSD.org
Subject: <userinput> and other tag usage
Message-ID: <alpine.BSF.2.00.1307251203130.12780@wonkity.com>
User-Agent: Alpine 2.00 (BSF 1167 2008-08-23)
MIME-Version: 1.0
Content-Type: TEXT/PLAIN; format=flowed; charset=US-ASCII
X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.4.3
 (wonkity.com [127.0.0.1]); Thu, 25 Jul 2013 12:15:37 -0600 (MDT)
X-BeenThere: freebsd-doc@freebsd.org
X-Mailman-Version: 2.1.14
Precedence: list
List-Id: Documentation project <freebsd-doc.freebsd.org>
List-Unsubscribe: <http://lists.freebsd.org/mailman/options/freebsd-doc>,
 <mailto:freebsd-doc-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/freebsd-doc>
List-Post: <mailto:freebsd-doc@freebsd.org>
List-Help: <mailto:freebsd-doc-request@freebsd.org?subject=help>
List-Subscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-doc>,
 <mailto:freebsd-doc-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Thu, 25 Jul 2013 18:15:44 -0000

When writing <userinput> sections, I've generally not used other markup 
inside those sections except for <replaceable>.  For example:

   <userinput>rm /tmp/foo</userinput>

However, there are some spots in the Handbook where <filename> tags are 
also used:

   <userinput>rm <filename>/tmp/foo</filename></userinput>

This looks different in the XHTML output, with the filename rendered in 
green.

I feel that the first form is correct, we are pointing out what the user 
should type, but can see benefits for the second.  I have not counted to 
see which form is prevalent, but think it is the first.  The FDP Primer 
actually uses a filename without filename tags in the <userinput> 
example.

Anyone care strongly either way?