Return-Path: 
 <user-return-28600-apmail-commons-user-archive=commons.apache.org@commons.apache.org>
X-Original-To: apmail-commons-user-archive@www.apache.org
Delivered-To: apmail-commons-user-archive@www.apache.org
Received: from mail.apache.org (hermes.apache.org [140.211.11.3])
	by minotaur.apache.org (Postfix) with SMTP id 3C7C610C21
	for <apmail-commons-user-archive@www.apache.org>;
 Tue, 27 Aug 2013 11:35:12 +0000 (UTC)
Received: (qmail 45014 invoked by uid 500); 27 Aug 2013 11:35:10 -0000
Delivered-To: apmail-commons-user-archive@commons.apache.org
Received: (qmail 44702 invoked by uid 500); 27 Aug 2013 11:35:10 -0000
Mailing-List: contact user-help@commons.apache.org; run by ezmlm
Precedence: bulk
List-Help: <mailto:user-help@commons.apache.org>
List-Unsubscribe: <mailto:user-unsubscribe@commons.apache.org>
List-Post: <mailto:user@commons.apache.org>
List-Id: <user.commons.apache.org>
Reply-To: "Commons Users List" <user@commons.apache.org>
Delivered-To: mailing list user@commons.apache.org
Received: (qmail 44665 invoked by uid 99); 27 Aug 2013 11:35:05 -0000
Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136)
    by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 27 Aug 2013 11:35:05 +0000
X-ASF-Spam-Status: No, hits=-0.0 required=5.0
	tests=SPF_PASS
X-Spam-Check-By: apache.org
Received-SPF: pass (athena.apache.org: local policy)
Received: from [50.22.11.58] (HELO bs3-dallas.accountservergroup.com)
 (50.22.11.58)
    by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 27 Aug 2013 11:34:59 +0000
Received: from dsl78-143-225-130.in-addr.fast.co.uk ([78.143.225.130]:55578
 helo=viper.int.arc7.info)
	by bs3-dallas.accountservergroup.com with esmtps (TLSv1:AES128-SHA:128)
	(Exim 4.80)
	(envelope-from <org.apache.commons@io7m.com>)
	id 1VEHXj-0009Nl-2f
	for user@commons.apache.org; Tue, 27 Aug 2013 06:34:39 -0500
Date: Tue, 27 Aug 2013 11:31:57 +0000
From: <org.apache.commons@io7m.com>
To: user@commons.apache.org
Subject: [cli] naming trailing arguments for help messages
Message-ID: <20130827113157.3cc5fed0@viper.int.arc7.info>
Mime-Version: 1.0
Content-Type: text/plain; charset=US-ASCII
Content-Transfer-Encoding: 7bit
X-ACL-Warn: {
X-AntiAbuse: This header was added to track abuse,
 please include it with any abuse report
X-AntiAbuse: Primary Hostname - bs3-dallas.accountservergroup.com
X-AntiAbuse: Original Domain - commons.apache.org
X-AntiAbuse: Originator/Caller UID/GID - [47 12] / [47 12]
X-AntiAbuse: Sender Address Domain - io7m.com
X-Get-Message-Sender-Via: bs3-dallas.accountservergroup.com: none
X-Virus-Checked: Checked by ClamAV on apache.org

Hello.

Is it possible to give names to the arguments not processed by CLI for
the purposes of help messages?

As an example, I have a program that takes an '-o' argument, and then
an unbounded number of files as arguments after the initial options. I'd
like the help message to read:

$ ./c
usage: c [-h] [-o output] file [file0 .. fileN]
    -h,--help                  Show this help message
    -o,--output <directory>    Output to the given directory

But as far as I can tell from the documentation, I can only get CLI to
give me:

$ ./c
usage: c [-h] [-o <directory>]
    -h,--help                  Show this help message
    -o,--output <directory>    Output to the given directory

Which is a vaguely misleading help message...

M

---------------------------------------------------------------------
To unsubscribe, e-mail: user-unsubscribe@commons.apache.org
For additional commands, e-mail: user-help@commons.apache.org