vrecord.1

.TH vrecord 1 "https://github.com/amiaopensource/vrecord" "2024-07-18" "AMIA Open Source"
.\" Turn off justification for nroff.
.if n .ad l
.\" Turn off hyphenation.
.nh
.SH NAME
vrecord - An Open-Source Video Capture Tool for Archivists
.SH SYNOPSIS
\fBvrecord\fR [\fB-e\fR | \fB-r \fIidentifier\fR | \fB-p\fR | \fB-a\fR | \fB-x\fR | \fB-n\fR | \fB-v\fR | \fB-h\fR]
.SH DESCRIPTION
Vrecord is open-source software for capturing a video signal and turning it into a digital file. Its purpose is to make videotape digitization or transfer easier. Vrecord can capture analog and digital signals through a variety of inputs and can create digital video files in a variety of formats and codecs. Vrecord has been designed with needs of audiovisual archivists in mind.
.PP
Currently vrecord only supports Blackmagic Design capture cards with the Blackmagic driver installed.
.SH OPTIONS
.TP 4
.B -e
Running vrecord in \fBEdit Mode\fR opens a GUI window that allows you to change your recording options and then start digitizing a tape.
.TP
.B -r
\fBRecord Mode\fR enables recording of a signal. This is the default mode.
.TP
.B -p
\fBPassthrough Mode\fR means that the vrecord window will appear with video feeds and scopes, but the incoming video signal will not be recorded to a file. Passthrough mode is best used for tasks like testing equipment or setting up a tape to bars before actually recording. When you are finished using passthrough mode simply close the vrecord window.
.TP
.B -a
\fBAudio Passthrough Mode\fR is the same as Passthrough Mode with the addition of audio bars to monitor levels. It can be used to check audio track layout and confirm input levels before starting a transfer. Currently Audio Passthrough Mode does not support the Visual + Numerical view option.
.TP
.B -x
\fBClear Configuration:\fR Use if you would like to clear all options set in the configuration file.
.TP
.B -n
\fBReset environmental variables:\fR Use if you would like to reset stored environmental variables such as path to ffmpeg-dl dependency.
.TP
.B -v
In the \fBVerbose Mode\fR ffmpeg runs with '-loglevel debug'. Using this option creates a very large log file, so avoid using this option with 'Visual + Numerical' or any playback option that display the log as part of the view.
.TP
.B -h
\fBHelp:\fR Displays basic usage information.
.SH ADVANCED OPTIONS
.TP 4
.B -I
Provide a string of input options for the recording ffmpeg to use. For example "vrecord -I '-loglevel trace'" would force an ffmpeg logging level that is usually unaccessible via vrecord preferences.
.TP
.B -O
Provide a string of output options for the recording ffmpeg to use.
.TP
.B -D
Provide a directory containing vrecord dependencies to store their paths in vrecord's environmental variables instead of defaults.
.TP
.B -i
Provide a file as an input to vrecord, rather than using the decklink device. For testing without a decklink device.
.TP
.B -G
Share warnings from gtkdialog and vrecord, otherwise there are suppressed by default.
.TP
.B -c
Provide a recording configuration file, rather than use the default one.
.SH LICENSE
Vrecord is licensed under a Creative Commons Attribution 4.0 International License.