add examples to dvrescue -h
Opened this issue · 2 comments
dericed commented
add examples to dvrescue -h
libbyhopfauf commented
I'm also updating the CLI documentation (see the revisions for dvcapture CLI at #922). Please feel free to correct any of my examples or add any others. When I have a deck tomorrow I can do some testing and add some more for capture and the other tools. And can add more generic examples/descriptions to dvrescue -h.
It looks like the current -h is missing some options.
libbyhopfauf commented
@dericed I've been working on this, but I think there might be a command I am missing or there is something out of order in the strings (see my latest draft and comments for #922 for more details). Here's what's in the most recent -h (see below). But I noticed in the debugging window for the GUI that it uses -y for some of the commands and I wasn't able to duplicate the same commands in the terminal using the CLI, so I am guessing I'm a little behind on what all is going on there?
libbyshopfauf@Libbys-MacBook-Pro-M2 ~ % dvrescue -h
Usage: "dvrescue FileName1 [Filename2...] [Options...]"
Options:
--help, -h
Display this help and exit.
--version
Display DVRescue version and exit.
--cc-format value
Set Closed Captions output format to value.
value can be 'scc', 'screen', 'srt'.
If there is more than one instance of this option,
this option is applied to the next --cc-output option.
--cc-output value | -c value
Store Closed Captions output to value (file name).
File extension must be the format name (see above)
if --cc-format is not provided.
if content is different between Dseq and/or has more than 1 field,
extension is prefixed by 'dseq%dseq%.' and/or 'field%field%.'.
There can be more than one instance of this option.
--cc-tc value
Set Closed Captions output start time code to value.
Used for SCC output.
value format is HH:MM:SS;FF, or 'dv' (for DV first frame time code).
--webvtt-output value | -s value
Store WebVTT output to value (file name).
--xml-output value | -x value
Store XML output to value (file name).
--merge value | -m value
Merge all input files into value (file name),
picking the best part of each file.
--merge-log value
Store merge log to value (file name).
--merge-output-speed
Report and merge frames having speed not meaning normal playback
Is default (it will change in the future).
--merge-ignore-speed
Do not report and do not merge frames having speed not
meaning normal playback.
--merge-output-concealed
Report and merge frames having all blocks concealed.
Is default (it will change in the future).
--merge-ignore-concealed
Do not report and do not merge frames having all blocks concealed.
--merge-log-missing
Report frames considered as missing (due to time code jump etc).
Is default if information output format is not CSV.
--merge-hide-missing
Do not report frames considered as missing (due to time code jump etc).
Is default if information output format is CSV.
--merge-log-intermediate
Display additional lines of information
about intermediate analysis during files merge.
Is default if information output format is not CSV.
--merge-hide-intermediate
Hide additional lines of information
about intermediate analysis during files merge.
Is default if information output format is CSV.
--csv
Output is in CSV format rather than human readable text.
--caption-presence-change value
Split XML "frames" elements when there is a caption presence
change (value = "y") or do not split (value = "n").
Default is "n".
--verbosity value | -v value
Verbosity of the output set to value:
0: no output.
5: summary only.
7: information per frame if there is a problem + summary.
9: information per frame + summary.
--timeout value
Time out limit for the device or pipe input ("-" file name) set to value (in seconds)
--capture
Launch capture.
Is the default if no --cmd option is provided.
Usable only if input is a device.
--in-control
Include an integrated command line input for controlling the input.
Usable only if input is a device.
--list_devices
List detected devices and their ID.
--list_devices_json
List detected devices and their ID (JSON output).
--status
Provide the status (playing, stop...) of the input.
By default device://0 is used.
Usable only if input is a device.
--cmd value
Send a command to the input.
By default device://0 is used.
Usable only if input is a device.
value may be:
play Set speed to 1.0 and mode to play.
srew Set speed to -1.0 and mode to play.
stop Set speed to 0.0 and mode to no-play.
rew Set speed to -2.0 and mode to play.
ff Set speed to 2.0 and mode to play.
--foreground
With --cmd or --speed, wait for the device to stop.
Usable only if input is a device.
--mode value
Send a command to the input with the specified mode.
By default device://0 is used.
By default value is n if speed is 0 else p.
Usable only if input is a device.
value may be:
n Set mode to no-play.
p Set mode to play.
--speed value
Send a command to the input with the specified speed (float).
By default device://0 is used.
By default value is 0 if mode is no-play else 1.
Usable only if input is a device.
--rewind-count value
Automatically rewind to last good frame and capture again,
value times.
Usable only if input is a device.
--rewind
Same as --rewind-count 1
--rewind-basename value
Base name of files storing buggy frames per take
Default is output file name.
If no output file name is provided, XML output is displayed on console output.