Skip to content

Commit 36556f3

Browse files
coolaj86wez
authored andcommitted
doc: add Usage to README.md
1 parent d813aa6 commit 36556f3

File tree

1 file changed

+88
-3
lines changed

1 file changed

+88
-3
lines changed

README.md

Lines changed: 88 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
AtomicParsley is a lightweight command line program for reading, parsing and
66
setting metadata into MPEG-4 files, in particular, iTunes-style metadata.
77

8-
## Installation
8+
## Install
99

1010
### macOS
1111

@@ -36,7 +36,93 @@ Note that the version available in brew may lag behind the latest version of the
3636
* Download the `AtomicParsleyAlpine.zip` file and extract `AtomicParsley`
3737
* And finally `apk add libstdc++`
3838
39-
### Building from Source
39+
## Usage
40+
41+
```txt
42+
AtomicParsley sets metadata into MPEG-4 files & derivatives supporting 3 tag
43+
schemes: iTunes-style, 3GPP assets & ISO defined copyright notifications.
44+
45+
AtomicParsley quick help for setting iTunes-style metadata into MPEG-4 files.
46+
47+
General usage examples:
48+
AtomicParsley /path/to.mp4 -T 1
49+
AtomicParsley /path/to.mp4 -t +
50+
AtomicParsley /path/to.mp4 --artist "Me" --artwork /path/to/art.jpg
51+
Atomicparsley /path/to.mp4 --albumArtist "You" --podcastFlag true
52+
Atomicparsley /path/to.mp4 --stik "TV Show" --advisory explicit
53+
54+
Getting information about the file & tags:
55+
-T --test Test file for mpeg4-ishness & print atom tree
56+
-t --textdata Prints tags embedded within the file
57+
-E --extractPix Extracts pix to the same folder as the mpeg-4 file
58+
59+
Setting iTunes-style metadata tags
60+
--artist (string) Set the artist tag
61+
--title (string) Set the title tag
62+
--album (string) Set the album tag
63+
--genre (string) Genre tag (see --longhelp for more info)
64+
--tracknum (num)[/tot] Track number (or track number/total tracks)
65+
--disk (num)[/tot] Disk number (or disk number/total disks)
66+
--comment (string) Set the comment tag
67+
--year (num|UTC) Year tag (see --longhelp for "Release Date")
68+
--lyrics (string) Set lyrics (not subject to 256 byte limit)
69+
--lyricsFile (/path) Set lyrics to the content of a file
70+
--composer (string) Set the composer tag
71+
--copyright (string) Set the copyright tag
72+
--grouping (string) Set the grouping tag
73+
--artwork (/path) Set a piece of artwork (jpeg or png only)
74+
--bpm (number) Set the tempo/bpm
75+
--albumArtist (string) Set the album artist tag
76+
--compilation (boolean) Set the compilation flag (true or false)
77+
--hdvideo (number) Set the hdvideo flag to one of:
78+
false or 0 for standard definition
79+
true or 1 for 720p
80+
2 for 1080p
81+
--advisory (string*) Content advisory (*values: 'clean', 'explicit')
82+
--stik (string*) Sets the iTunes "stik" atom (see --longhelp)
83+
--description (string) Set the description tag
84+
--longdesc (string) Set the long description tag
85+
--storedesc (string) Set the store description tag
86+
--TVNetwork (string) Set the TV Network name
87+
--TVShowName (string) Set the TV Show name
88+
--TVEpisode (string) Set the TV episode/production code
89+
--TVSeasonNum (number) Set the TV Season number
90+
--TVEpisodeNum (number) Set the TV Episode number
91+
--podcastFlag (boolean) Set the podcast flag (true or false)
92+
--category (string) Sets the podcast category
93+
--keyword (string) Sets the podcast keyword
94+
--podcastURL (URL) Set the podcast feed URL
95+
--podcastGUID (URL) Set the episode's URL tag
96+
--purchaseDate (UTC) Set time of purchase
97+
--encodingTool (string) Set the name of the encoder
98+
--encodedBy (string) Set the name of the Person/company who encoded the file
99+
--apID (string) Set the Account Name
100+
--cnID (number) Set the iTunes Catalog ID (see --longhelp)
101+
--geID (number) Set the iTunes Genre ID (see --longhelp)
102+
--xID (string) Set the vendor-supplied iTunes xID (see --longhelp)
103+
--gapless (boolean) Set the gapless playback flag
104+
--contentRating (string*) Set tv/mpaa rating (see -rDNS-help)
105+
106+
Deleting tags
107+
Set the value to "": --artist "" --stik "" --bpm ""
108+
To delete (all) artwork: --artwork REMOVE_ALL
109+
manually removal: --manualAtomRemove "moov.udta.meta.ilst.ATOM"
110+
111+
More detailed iTunes help is available with AtomicParsley --longhelp
112+
Setting reverse DNS forms for iTunes files: see --reverseDNS-help
113+
Setting 3gp assets into 3GPP & derivative files: see --3gp-help
114+
Setting copyright notices for all files: see --ISO-help
115+
For file-level options & padding info: see --file-help
116+
Setting custom private tag extensions: see --uuid-help
117+
Setting ID3 tags onto mpeg-4 files: see --ID3-help
118+
119+
----------------------------------------------------------------------
120+
AtomicParsley version: 20221229.172126.0 d813aa6e0304ed3ab6d92f1ae96cd52b586181ec (utf8)
121+
122+
Submit bug fixes to https://github.com/wez/atomicparsley
123+
```
124+
125+
## Build from Source
40126

41127
If you are building from source you will need `cmake` and `make`.
42128
On Windows systems you'll need Visual Studio or MingW.
@@ -53,7 +139,6 @@ will generate an `AtomicParsley` executable.
53139
zlib - used to compress ID3 frames & expand already compressed frames
54140
available from http://www.zlib.net
55141

56-
57142
## A note on maintenance!
58143

59144
> I made some fixes to the original project on sourceforge back in 2009 and

0 commit comments

Comments
 (0)