Travis Shirk avatar Travis Shirk committed 68150f6

moar

Comments (0)

Files changed (11)

bin/cli_examples.sh

 # [[[section REMOVE_ALL_TAGS]]]
 eyeD3 --remove-all example.id3
 # [[[endsection]]]
+
+# [[[section GENRES_PLUGIN1]]]
+eyeD3 --plugin=genres
+# [[[endsection]]]
+
+# [[[section LAME_PLUGIN]]]
+eyeD3 -P lameinfo src/test/data/notag-vbr.mp3
+# [[[endsection]]]

docs/plugins/classic_plugin.rst

 Notice how the genre displayed as "Hardcore (id 129)" in the above tag listing.
 This happens because the genre is a recognized value as defined by the ID3 v1
 standard. eyeD3 used to be very strict about genres, but no longer. You can
-store any value you'd like.
+store any value you'd like. For a list of recognized genres and their
+respective IDs see the `genres plugin <genres_plugin.html>`_.
 
 TODO: reference genres plubin
 
 the tag itself. Let's try that now.
 
 .. code-block:: bash
+
   $ eyeD3 --add-image http://example.com/cover.jpg:FRONT_COVER
   eyeD3: error: argument --add-image: invalid ImageArg value: 'http://example.com/cover.jpg:FRONT_COVER'
 

docs/plugins/genres_plugin.rst

 .. cog.out(cog_pluginHelp("genres"))
 .. }}}
 .. {{{end}}}
+
+Example
+-------
+
+.. {{{cog cli_example("bin/cli_examples.sh", "GENRES_PLUGIN1", lang="bash") }}}
+.. {{{end}}}

docs/plugins/lameinfo_plugin.rst

 .. cog.out(cog_pluginHelp("lameinfo"))
 .. }}}
 .. {{{end}}}
+
+Example
+-------
+
+.. {{{cog cli_example("bin/cli_examples.sh", "LAME_PLUGIN", lang="bash") }}}
+.. {{{end}}}

docs/plugins/mimetypes_plugin.rst

 .. }}}
 .. {{{end}}}
 
+Example
+-------
+
+.. code-block:: bash
+
+  $ eyeD3 -P mt /home/travis/music/ 2> /dev/null
+
+  28575 files checked
+  Mime-types:
+  None                :       1 (%0.00)
+  application/pdf     :       2 (%0.01)
+  application/x-trash :       7 (%0.02)
+  audio/mpeg          :   27559 (%96.44)
+  image/gif           :       7 (%0.02)
+  image/jpeg          :     982 (%3.44)
+  image/png           :      16 (%0.06)
+  text/plain          :       1 (%0.00)

docs/plugins/nfo_plugin.rst

 .. cog.out(cog_pluginHelp("nfo"))
 .. }}}
 .. {{{end}}}
+
+Example
+-------
+
+.. code-block:: bash
+
+  $ eyeD3 -P nfo ~/music/Nine\ Inch\ Nails/1992\ -\ Broken/
+
+  Artist   : Nine Inch Nails
+  Album    : Broken
+  Released : 1992
+  Genre    : Noise
+  
+  Source  : 
+  Encoder : LAME3.95
+  Codec   : mp3
+  Bitrate : ~167 K/s @ 44100 Hz, Joint stereo
+  Tag     : ID3 v2.3
+
+  Ripped By: 
+
+  Track Listing
+  -------------
+   1. Pinion                 (01:02)
+   2. Wish                   (03:46)
+   3. Last                   (04:44)
+   4. Help Me I am in Hell   (01:56)
+   5. Happiness in Slavery   (05:21)
+   6. Gave Up                (04:08)
+   7. Physical (You're So)   (05:29)
+   8. Suck                   (05:07)
+
+  Total play time : 31:33
+  Total size      : 37.74 MB
+
+  ==============================================================================
+  .NFO file created with eyeD3 0.7.0 on Tue Oct 23 23:44:27 2012
+  For more information about eyeD3 go to http://eyeD3.nicfit.net/
+  ==============================================================================
+
     if buffer.strip():
         substs["options"] = buffer
     else:
-        substs["options"] = u"None"
+        substs["options"] = u"  No extra options supported"
 
     return template.substitute(substs)
 __builtins__["cog_pluginHelp"] = cog_pluginHelp

src/eyed3/plugins/examples.py

 
 
 class MimeTypesPlugin(Plugin):
-    SUMMARY = u"Displays the mime-type for each file encountered"
     NAMES = ["mimetypes", "mt"]
+    SUMMARY = u"Displays the mime-type for each file scanned."
 
     def __init__(self, arg_parser):
         self.mts = {}
 
 class GenreListPlugin(Plugin):
     SUMMARY = u"Display the full list of standard ID3 genres."
+    DESCRIPTION = u"ID3 v1 defined a list of genres and mapped them to "\
+                   "to numeric values so they can be stored as a single "\
+                   "byte. It is *recommended* that these genres are used "\
+                   "although most newer software (including eyeD3) does not "\
+                   "care."
     NAMES = ["genres"]
 
     def start(self, args, config):

src/eyed3/plugins/lameinfo.py

 class LameInfoPlugin(LoaderPlugin):
     NAMES = ["lameinfo", "xing"]
     SUMMARY = u"Outputs lame header (if one exists) for file."
+    DESCRIPTION = (
+        u"The 'lame' (or xing) header provides extra information about the mp3 "
+         "that is useful to players and encoders but not officially part of "
+         "the mp3 specification. Variable bit rate mp3s, for example, use this "
+         "header.\n\n"
+         "For more details see "
+         "`here <http://gabriel.mp3-tech.org/mp3infotag.html>`_"
+         )
 
     def printHeader(self, filePath):
         from stat import ST_SIZE

src/eyed3/plugins/nfo.py

 
 class NfoPlugin(LoaderPlugin):
     NAMES = ["nfo"]
-    SUMMARY = u"Outputs an NFO description for each album processed. " \
-               "(http://en.wikipedia.org/wiki/.nfo)"
+    SUMMARY = u"Create NFO files for each directory scanned."
+    DESCRIPTION = u"Each directory scanned is treated as an album and a "\
+                   "`NFO <http://en.wikipedia.org/wiki/.nfo>`_ file is "\
+                   "written to standard out.\n\n"\
+                   "NFO files are often found in music archives."
 
     def __init__(self, arg_parser):
         super(NfoPlugin, self).__init__(arg_parser)

src/eyed3/plugins/statistics.py

 
 class StatisticsPlugin(LoaderPlugin):
     NAMES = ['stats']
-    SUMMARY = u"Computes statistics for all audio file and tags "\
-               "encountered. For example, ID3 version, bitrate info, etc."
+    SUMMARY = u"Computes statistics for all audio files scanned."
 
     def __init__(self, arg_parser):
         super(StatisticsPlugin, self).__init__(arg_parser)
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.