Examples on ManPage?

Asked by Si Dedman on 2014-07-24

Would it be possible to include and example or two on the manpage (http://manpages.ubuntu.com/manpages/karmic/man1/mp3check.1.html)? I'm sure you guys are so deep into coding now that this is basic stuff, but it's still a read headache for many of us. Proposed text below, but other useful ones would of course be welcome:

"Examples:
Open Terminal anywhere & use full path (in quotes if files or folders have spaces):

mp3check -e --cut-junk-start --cut-junk-end --recursive --only-mp3 "/media/MyDrive/Music/Artist/Album/"
This checks for errors and cuts any junk found from the start and end of all (and only) mp3 files found in the specified folder and folders below it.

mp3check -e --cut-junk-start --cut-junk-end "/media/MyDrive/Music/Artist/Album/Artist - Title.mp3"
This does the same as above but for one file only. Recursive & OnlyMP3 are redundant but won't cause a problem if included.

Cheers. I've not tried to do anything clever but if you have any tricks or favourite uses it might be nice to include those also.

Question information

Language:
English Edit question
Status:
Solved
For:
Ubuntu mp3check Edit question
Assignee:
No assignee Edit question
Solved by:
Thomas Krüger
Solved:
2014-07-28
Last query:
2014-07-28
Last reply:
2014-07-24
Si Dedman (si-dedman) said : #1

Related, based on my bug reporting in the bug section: also an option to add:

" --fix-headers
              fix invalid headers (prevent constant parameter switching),
              implies -e, use with care. Incompatible with VBR files and will destroy them"

and

" -e --error-check
              check crc and headers for consistency and print several error
              messages. Not required for checking junk frames"

I don't know how true either of these are - the manpage is rather ambiguous, so more detail would be helpful. Does one need to use "-e" to check for errors? Currently I assume you do but then if you always need it, why isn't it a default? So I suspect I'm wrong, and it's a switch only to check CRC & headers, whereas junk (and other stuff, e.g. truncated frames?) will be reported (?) and fixed (with appropriate switches) even if "-e" is omitted.

Sorry for cross posting & walls of text!

Best Thomas Krüger (thkrueger) said : #2

It's an Open Source protect, you can participate.
The best way to do that is to send your changes to the origin project at https://code.google.com/p/mp3check/ .

Check out their code via Subversion, make the changes, "svn diff" to create a patch file and send it in.

Si Dedman (si-dedman) said : #3

Cheers Thomas, I'll do so!

Si Dedman (si-dedman) said : #4

Thanks Thomas Krüger, that solved my question.