MediaArea / MediaConch

MediaConch (funded by PREFORMA)
31 stars 11 forks source link

[Wish] change `-h` to fit 80 chars width #184

Closed retokromer closed 7 years ago

retokromer commented 7 years ago

The output of mediaconch -h is ugly on a standard monitor with 80 chars width:

MediaConch Command Line Interface 17.05
Usage: "MediaConch [-Options...] FileName1 [Filename2...]"

Options:
Help:
--Help, -h
                    Display this help and exit
--Help=Advanced, -ha
                    Display the advanced help and exit
--Version, -v
                    Display the version and exit

--User=UserID, -u UserID
                    CLI user will be UserID

Configuration Element:
--Configuration=ConfigurationFile, -c ConfigurationFile
                    Use ConfigurationFile as configuration file
                    Default, it uses the one in the user data application file
--PluginsConfiguration=PluginsConfigurationFile, -pc PluginsConfigurationFile
                    Use PluginsConfigurationFile as plugins configuration file
                    Default, it uses the struct in the configuration file or no
plugins configured if not inside.
Reporting Elements:
--Mediaconch, -mc
                    Output MediaConch report (default)
                    (MediaConch contains default verbosity of
implementationChecks plus any provided policy checks.)
--Mediainfo, -mi
                    Output MediaInfo report
--Mediatrace, -mt
                    Output a trace of the file

Policy Checker:
--Policy=PolicyFileName, -p PolicyFileName
                    Apply the policy (XSL or Schematron) 
--CreatePolicy
                    Create a policy (XSL) from a file
--PolicyReferenceFile=VideoFile, -prf VideoFile
                    Use the VideoFile as reference to compare in policy

Output Formats:
--Format=text -ft
                    Output MediaConch reports in Text format
--Format=xml -fx
                    Output MediaConch reports in XML format
                    (changed to -fa if there are more than 1 tool or more than 1
file)
--Format=html -fh
                    Output MediaConch reports in HTML format
--Format=simple -fs
                    Output MediaConch reports in a shorten form (>1 line only if
there are errors), default format
--Format=csv -fc
                    Output MediaConch reports in CSV format (only for policies)
--Format=maxml -fa
                    Output in MediaArea XML format
--Display=DisplayFileName, -d DisplayFileName
                    Apply the display transformation (XSL)

--List
                    List files analyzed.

Watch folder:
--WatchFolders-List, -wfl
                    List the folder watched
--WatchFolder=folder -wf folder
                    Send to the server a folder to watch
--WatchFolder-Reports=folder -wfr folder
                    Create reports of the selected watch folder to this folder
--WatchFolder-Not-Recursive
                    If watch folder is enabled, do not check recursively the folder
--WatchFolder-User=userId -wfu userId
                    Create reports of the watch folder for the selected user ID

Plugins:
--PluginsList
                    Output the plugins information ID
--UsePlugin=PluginId, -up PluginId
                    By default, only format plugin are used.
                    With this command, you can give the plugin ID you want to
use.
                    Plugin ID can be get using the --pluginslist.

File:
--FileInformation, -fi
                 Print files information and quit
retokromer commented 7 years ago

I just notice that the example is better than with a normal Terminal, as mine considers full words and does not cut in the middle of a word.

retokromer commented 7 years ago

The wish is fulfilled in https://github.com/MediaArea/MediaConch_SourceCode/pull/588.