From owner-freebsd-doc@FreeBSD.ORG  Sun Mar 22 01:35:43 2015
Return-Path: <owner-freebsd-doc@FreeBSD.ORG>
Delivered-To: freebsd-doc@freebsd.org
Received: from mx1.freebsd.org (mx1.freebsd.org [8.8.178.115])
 (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits))
 (No client certificate requested)
 by hub.freebsd.org (Postfix) with ESMTPS id B271794F
 for <freebsd-doc@freebsd.org>; Sun, 22 Mar 2015 01:35:43 +0000 (UTC)
Received: from wonkity.com (wonkity.com [67.158.26.137])
 (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))
 (Client CN "wonkity.com", Issuer "wonkity.com" (not verified))
 by mx1.freebsd.org (Postfix) with ESMTPS id 5F3857BF
 for <freebsd-doc@freebsd.org>; Sun, 22 Mar 2015 01:35:42 +0000 (UTC)
Received: from wonkity.com (localhost [127.0.0.1])
 by wonkity.com (8.14.9/8.14.9) with ESMTP id t2M1ZZ08032787
 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=NO);
 Sat, 21 Mar 2015 19:35:35 -0600 (MDT)
 (envelope-from wblock@wonkity.com)
Received: from localhost (wblock@localhost)
 by wonkity.com (8.14.9/8.14.9/Submit) with ESMTP id t2M1ZZOL032784;
 Sat, 21 Mar 2015 19:35:35 -0600 (MDT)
 (envelope-from wblock@wonkity.com)
Date: Sat, 21 Mar 2015 19:35:35 -0600 (MDT)
From: Warren Block <wblock@wonkity.com>
To: Raphael Abreu <raphael.lorenzeto@gmail.com>
Subject: Re: Proposed improvement to LOGGER(1)
In-Reply-To: <CALCcL1hsr5fa0UhcQNBiVQTyhVpkrv-4tg_bgomwHm7Pgio+sg@mail.gmail.com>
Message-ID: <alpine.BSF.2.20.1503211926540.11013@wonkity.com>
References: <CALCcL1hsr5fa0UhcQNBiVQTyhVpkrv-4tg_bgomwHm7Pgio+sg@mail.gmail.com>
User-Agent: Alpine 2.20 (BSF 67 2015-01-07)
MIME-Version: 1.0
Content-Type: text/plain; charset=US-ASCII; format=flowed
X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.4.3
 (wonkity.com [127.0.0.1]); Sat, 21 Mar 2015 19:35:35 -0600 (MDT)
Cc: freebsd-doc@freebsd.org
X-BeenThere: freebsd-doc@freebsd.org
X-Mailman-Version: 2.1.18-1
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: Sun, 22 Mar 2015 01:35:43 -0000

On Tue, 17 Mar 2015, Raphael Abreu wrote:

> Hello everyone,
>
> This is the first time I am sumbitting an e-mail to this list so sorry if I
> break any protocols.
>
> I would like to propose an improvement to the LOGGER(1) entry:
>
> https://www.freebsd.org/cgi/man.cgi?query=logger%281%29
>
> Where it reads:
>
> *-f*	*file*
> 	     Log the specified file.
>
> For clarification it should read:
>
> *-f*	*file*
> 	     Log the contents of specified file. This option cannot be
> combined with a command-line message.
>
> I struggled for some time with this parameter and only understood what was
> going on after reading a GNU version:
>
> http://praxis.edoceo.com/man/1/LOGGER
>
> Searching on stackexchange and other sites I could see that mistaking the
> meaning of this flag is quite common.
>
> I hope this can be a positve contribuition.

The man page for FreeBSD 11 already has a better description, although 
it does not describe the behavior when both -f and a message are given. 
Even if the copyright of the Linux man page allowed us to copy it 
directly, it does not really describe what happens when both -f and a 
message are given.  Instead, I have committed this original update:
https://svnweb.freebsd.org/base/head/usr.bin/logger/logger.1?r1=280336&r2=280335&pathrev=280336

This was committed to -CURRENT, and will be MFCed into FreeBSD 10-STABLE 
in a week or so.

Thanks!