blob: a34506e3169f5dc67ffdfc8a3567c11682607c77 [file] [log] [blame]
.\" args - manipulate and output command arguments.
.\" Copyright (c) 2010 David Sugar <dyfet@gnutelephony.org>
.\"
.\" This manual page is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 3 of the License, or
.\" (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program; if not, write to the Free Software
.\" Foundation, Inc.,59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
.\"
.\" This manual page is written especially for Debian GNU/Linux.
.\"
.TH args "1" "January 2010" "GNU uCommon" "GNU Telephony"
.SH NAME
args \- manipulate and output command arguments.
.SH SYNOPSIS
.B args
.RI [ options ]
.I args...
.br
.SH DESCRIPTION
This command is used to manipulate and echo command line arguments to
standard out. This can include adding quotes around each argument passed
or a separator, or to output each argument on a separate line. The program
source also offers a basic example of how to use shell argument parsing and
localization in ucommon.
.SH OPTIONS
.TP
.BI \-\-delim= char
Set a deliminator character, such as ',', to use between each argument when
outputing arguments.
.TP
.B \-\-directory
If argument is a directory, list directory contents as arguments.
.TP
.B \-\-follow
If argument is a directory and a symlink, follow symlinks recursively.
.TP
.B \-\-lines
Output each argument on a separate line.
.TP
.BI \-\-quote= char|pair
Set a quote or special leading and trailing pair of characters to surround
each argument with when output. A typical use might be --quote=() to surround
arguments in parenthesis.
.TP
.B \-\-recursive
If argument is a directory, recursively scan directory and any subdirectory
contents as arguments.
.TP
.B \-\-reverse
Reverse order of arguments.
.TP
.B \-\-help
Outputs help screen for the user.
.SH AUTHOR
.B args
was written by David Sugar <dyfet@gnutelephony.org>.
.SH "REPORTING BUGS"
Report bugs to bug-commoncpp@gnu.org.
.SH COPYRIGHT
Copyright \(co 2009 David Sugar, Tycho Softworks.
.br
This is free software; see the source for copying conditions. There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE.