Changeset - 48dc373f9a02
[Not reviewed]
default
0 2 0
Dennis Fink - 7 years ago 2013-03-04 21:27:13
the_metalgamer@hackerspace.lu
updated documentation and usage function
2 files changed with 33 insertions and 10 deletions:
yaah
27
4
0 comments (0 inline, 0 general)
yaah
Show inline comments
 
#!/bin/bash -
 

	
 
#:        Title: yaah - Yet another AUR helper
 
#:     Synopsis:
 
#:      Options:
 
#:     Synopsis: yaah [options] [packages]
 
#:               yaah (packages)
 
#:      Options: -h, --help                            Display help
 
#:               -c, --check                           Check installed, foreign
 
#:                                                     packages if there are
 
#:                                                     updates available
 
#:               -d directory, --downloaddir=directory Download packages to the
 
#:                                                     specified directory
 
#:               -v, --verbose                         Be more verbose, can be
 
#:                                                     supplied at  maximum 2
 
#:                                                     times
 
#:               -q, --quiet                           Be less verbose. Takes
 
#:                                                     precedence over -v and
 
#:                                                     --verbose
 
#: Requirements: jshon <http://kmkeen.com/jshon/>
 
#:      Version: 0.1-alpha
 
#:      Created: 2013-02-26
 
#:     Revision: 2013-02-26
 
#:     Revision: 2013-03-04
 
#:       Author: Dennis Fink <the_metalgamer@hackerspace.lu>
 

	
 
## Security
...
 
@@ -306,9 +318,20 @@ download () {
 

	
 
usage() {
 
    printf "$SCRIPTNAME - $DESCRIPTION
 

	
 
    Download packages from AUR or check installed, foreign packages, if there are updates available.
 

	
 
    Usage: $SCRIPTNAME [options] [packages]
 
           $SCRIPTNAME (packages)
 

	
 
    Options:
 
    -h, --help Display help
 
    -c, --check Check installed packages if there are updates
 
    -d, --downloaddir <directory> Download packages to the specified directory\n"
 
    -d directory, --downloaddir=directory   Download packages to the specified directory
 
    -v, --verbose                           Be more verbose, can be supplied at maximum 2 times
 
    -q, --quiet                             Be less verbose. Takes precedence over -v and --verbose
 

	
 
    For complete documentation, run: man 8 yaah\n"
 
}
 

	
 

	
yaah.rst
Show inline comments
...
 
@@ -7,7 +7,7 @@ Yet another AUR helper
 
----------------------
 

	
 
:Author:         Dennis Fink <the_metalgamer@hackerspace.lu>
 
:Date:           2013-02-26
 
:Date:           2013-03-04
 
:Copyright:      GPLv3+
 
:Version:        Yaah 0.1-alpha
 
:Manual section: 8
...
 
@@ -31,11 +31,11 @@ there are updates available.
 
OPTIONS
 
=======
 

	
 
-h, --help                              Display help
 
-c, --check                             Check installed packages if there are updates available
 
-d directory, --downloaddir=directory   Download packages to the specified directory
 
-v, --verbose                           Be more verbose, can be supplied at maximum 2 times
 
-q, --quiet                             Be less verbose. Takes precedence over -v and --verbose
 
-h, --help                              Display help.
 
-c, --check                             Check installed, foreign packages, if there are updates available.
 
-d directory, --downloaddir=directory   Download packages to the specified directory.
 
-v, --verbose                           Be more verbose, can be supplied at maximum 2 times.
 
-q, --quiet                             Be less verbose. Takes precedence over -v and --verbose.
 

	
 
EXAMPLES
 
========
0 comments (0 inline, 0 general)