diff --git a/README.md b/README.md index 29493ed..86c6e30 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,36 @@ # flacinfo A script analoguous to `mp3info`, but for flac files. + +## Usage + +``` +usage: flacinfo [-h] [-a ARTIST] [-c COMMENT] [-g GENRE] [-l ALBUM] + [-m ALBUMNUMBER] [-n TRACK] [-t TITLE] [-y YEAR] + FILE [FILE ...] + +Edit flac files' metadata + +positional arguments: + FILE The file(s) to work on + +optional arguments: + -h, --help show this help message and exit + -a ARTIST, --artist ARTIST + Specify artist name + -c COMMENT, --comment COMMENT + Specify an arbitrary comment + -g GENRE, --genre GENRE + Specify genre (in plain text) + -l ALBUM, --album ALBUM + Specify album name + -m ALBUMNUMBER, --albumnumber ALBUMNUMBER + Specify album number + -n TRACK, --track TRACK + Specify track number + -t TITLE, --title TITLE + Specify track title + -y YEAR, --year YEAR Specify album year + +When no option modifying the tags is passed, the currently set tags are shown. +``` diff --git a/flacinfo b/flacinfo index 0893855..ef1c987 100755 --- a/flacinfo +++ b/flacinfo @@ -37,7 +37,9 @@ class NoSuchTag(Exception): def argparser(): """ Parses the arguments from sys.argv """ parser = argparse.ArgumentParser( - description="Edit flac files' metadata") + description="Edit flac files' metadata", + epilog=('When no option modifying the tags is passed, the currently ' + 'set tags are shown.')) parser.add_argument('-a', '--artist', help="Specify artist name") parser.add_argument('-c', '--comment',