table of contents
RECORDMYDESKTOP(1) | General Commands Manual | RECORDMYDESKTOP(1) |
NAME¶
recordMyDesktop - record desktop sessions to an Ogg-Theora-Vorbis file.SYNOPSIS¶
recordmydesktop [ Options ]^ filenameDESCRIPTION¶
recordMyDesktop produces a file(default out.ogv) that contains a video and audio recording
EXIT STATUS¶
0 is successOPTIONS¶
Generic Options:-
-h or --help -
Print help summary and exit.
-
--version -
Print program version and exit.
-
--print-config -
Print info about options selected during compilation and exit.
-
--windowid id_of_window -
id of window to be recorded.
-
--display DISPLAY -
Display to connect to.
-
-x X -
Offset in x direction.
-
-y Y -
Offset in y direction.
-
--width N -
Width of recorded window.
-
--height N -
Height of recorded window.
-
--dummy-cursor color -
Draw a dummy cursor, instead of the normal one.Value of color can be "black" or "white".
-
--no-cursor -
Disable drawing of the cursor.
-
--no-shared -
Disable usage of MIT-shared memory extension (Not Recommended).
-
--full-shots -
Take full screenshot at every frame(Not recomended!).
-
--follow-mouse -
When this option is enabled, the capture area follows the mouse cursor. This
is meaningfull only when the selected area is a subset of the full screen.
This option auto-enables --full-shots.
-
--quick-subsampling -
Do subsampling of the chroma planes by discarding extra pixels.
-
--fps N(number>0.0) -
A positive number denoting desired framerate.
-
--channels N(number>0) -
A positive number denoting desired sound channels in recording.
-
--freq N(number>0) -
A positive number denoting desired sound frequency.
-
--buffer-size N(number>0) -
A positive number denoting the desired sound buffer size(in frames, when using ALSA or OSS).
-
--ring-buffer-size N(float number>0) -
A float number denoting the desired ring buffer size (in seconds,when using JACK only).
The overall size of the buffer in bytes will be:
ring_buffer_size * samplerate * number_of_ports * sizeof(jack_default_audio_sample_t),
where sizeof(jack_default_audio_sample_t) is normally 4.
-
--device SOUND_DEVICE -
Sound device(default hw:0,0 or /dev/dsp, depending on whether ALSA or OSS is used).
-
--use-jack port1 port2... portn -
Record audio from the specified list of space-separated jack ports.
When using this option, all the rest audio related ones(except --no-sound) are not taken into account.
-
--no-sound -
Do not record sound.
-
--on-the-fly-encoding -
Encode the audio-video data, while recording.
-
--v_quality n -
A number from 0 to 63 for desired encoded video quality(default 63).
-
--v_bitrate n -
A number from 45000 to 2000000 for desired encoded video bitrate(default 45000).
-
--s_quality n -
Desired audio quality(-1 to 10).
-
--rescue path_to_data -
Encode cache data from a previous session, into an Ogg/Theora+Vorbis
file. The filename will be the one that was chosen initially.
Any other option specified with this one will be implicitly ignored
and recordMyDesktop will exit after the end of the encoding.
This option was added in recordMyDesktop 0.3.7 and it will not
work with cache files produced from earlier versions.
When using this option, remember that recordMyDesktop's cache is
not safe, in respect to type-sizes and endianness.
-
--print-config -
Print compilation time options. Currently prints whether Jack capture is
enabled and if ALSA or OSS is used (may contain more information
in the future).
-
--no-wm-check -
When a 3d compositing window manager is detected the program will function as if the
--full-shots option has been specified. This option disables that
behavior alltogether.
-
--no-frame -
Normally, around the recording area, there is drawn a frame to assist
the user in identifying what does and what doesn't get captured.
This frame will also follow around the mouse, when --follow-mouse
is used. The frame might cause problems for drag and drop. If you do
not wish this frame to appear, use this option.
-
--pause-shortcut MOD+KEY -
Shortcut that will be used for pausing or unpausing the recording.
MOD can be any combination of the following modifier keys:
Control, Shift and Mod1 to Mod5. The modifiers can be separated
with any character( except SPACE ) or none at all. KEY can be any key defined in
/usr/include/X11/keysymdef.h without the XK_ prefix.
The list of modifiers must be separated from the key with a plus('+')
sign.
Default is Control+Mod1+p (Mod1 usually corresponds to left Alt).
-
--stop-shortcut MOD+KEY -
Shortcut that will be used to stop the recording.
For more, see -pause-shortcut above.
Default is Control+Mod1+s.
-
--compress-cache -
Image data are cached with a light compression.
-
--workdir DIR -
Location where a temporary directory will be created to hold project files(default /tmp).
-
--delay n[H|h|M|m] -
Number of secs(default),minutes or hours before capture starts(number can be float).
-
--overwrite -
If there is already a file with the same name, delete it.
Default action is to add a number postfix to the new file.
For example when not specifying a name, if out.ogv exists,
the new file will be out-1.ogv and if that exists too, out-2.ogv
and so on (no ad-infinitum though, more like ad-short-integer...)
-
-o filename -
Name of recorded video(default out.ogv).
USAGE¶
- recordmydesktop [OPTIONS]^filename
-
ENVIRONMENT¶
- DISPLAY
-
NOTES¶
Recording a window using the --windowid option, doesn't track the window itself, but the region that it covers.
Also, the lower quality you select on a video recording ( -v_quality option), the highest CPU-power that you will need.
BUGS¶
Does not record 3d windows, if --full-shots isn't specified.AUTHORS¶
John Varouhakis(johnvarouhakis@gmail.com)SEE ALSO¶
xwininfo(1)13/7/2006 | Linux |