| Alexandre Lision | ddd731e | 2014-01-31 11:50:08 -0500 | [diff] [blame] | 1 | .\" args - manipulate and output command arguments. |
| 2 | .\" Copyright (c) 2010 David Sugar <dyfet@gnutelephony.org> |
| 3 | .\" |
| 4 | .\" This manual page is free software; you can redistribute it and/or modify |
| 5 | .\" it under the terms of the GNU General Public License as published by |
| 6 | .\" the Free Software Foundation; either version 3 of the License, or |
| 7 | .\" (at your option) any later version. |
| 8 | .\" |
| 9 | .\" This program is distributed in the hope that it will be useful, |
| 10 | .\" but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 11 | .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 12 | .\" GNU General Public License for more details. |
| 13 | .\" |
| 14 | .\" You should have received a copy of the GNU General Public License |
| 15 | .\" along with this program; if not, write to the Free Software |
| 16 | .\" Foundation, Inc.,59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
| 17 | .\" |
| 18 | .\" This manual page is written especially for Debian GNU/Linux. |
| 19 | .\" |
| 20 | .TH args "1" "January 2010" "GNU uCommon" "GNU Telephony" |
| 21 | .SH NAME |
| 22 | args \- manipulate and output command arguments. |
| 23 | .SH SYNOPSIS |
| 24 | .B args |
| 25 | .RI [ options ] |
| 26 | .I args... |
| 27 | .br |
| 28 | .SH DESCRIPTION |
| 29 | This command is used to manipulate and echo command line arguments to |
| 30 | standard out. This can include adding quotes around each argument passed |
| 31 | or a separator, or to output each argument on a separate line. The program |
| 32 | source also offers a basic example of how to use shell argument parsing and |
| 33 | localization in ucommon. |
| 34 | .SH OPTIONS |
| 35 | .TP |
| 36 | .BI \-\-delim= char |
| 37 | Set a deliminator character, such as ',', to use between each argument when |
| 38 | outputing arguments. |
| 39 | .TP |
| 40 | .B \-\-directory |
| 41 | If argument is a directory, list directory contents as arguments. |
| 42 | .TP |
| 43 | .B \-\-follow |
| 44 | If argument is a directory and a symlink, follow symlinks recursively. |
| 45 | .TP |
| 46 | .B \-\-lines |
| 47 | Output each argument on a separate line. |
| 48 | .TP |
| 49 | .BI \-\-quote= char|pair |
| 50 | Set a quote or special leading and trailing pair of characters to surround |
| 51 | each argument with when output. A typical use might be --quote=() to surround |
| 52 | arguments in parenthesis. |
| 53 | .TP |
| 54 | .B \-\-recursive |
| 55 | If argument is a directory, recursively scan directory and any subdirectory |
| 56 | contents as arguments. |
| 57 | .TP |
| 58 | .B \-\-reverse |
| 59 | Reverse order of arguments. |
| 60 | .TP |
| 61 | .B \-\-help |
| 62 | Outputs help screen for the user. |
| 63 | .SH AUTHOR |
| 64 | .B args |
| 65 | was written by David Sugar <dyfet@gnutelephony.org>. |
| 66 | .SH "REPORTING BUGS" |
| 67 | Report bugs to bug-commoncpp@gnu.org. |
| 68 | .SH COPYRIGHT |
| 69 | Copyright \(co 2009 David Sugar, Tycho Softworks. |
| 70 | .br |
| 71 | This is free software; see the source for copying conditions. There is NO |
| 72 | warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR |
| 73 | PURPOSE. |
| 74 | |
| 75 | |