diff --git a/doc/howto.md b/doc/howto.md index 19cd343..b87902d 100644 --- a/doc/howto.md +++ b/doc/howto.md @@ -1,6 +1,6 @@ # MUXSA HOWTO -This is the step-by-step documentation how to use muxsa. For an overview on muxsa please watch the [Demonstration video (a.k.a. the making of Network Security 2020)](https://nks-devel3.rus.uni-stuttgart.de/muxsa/making_of_netsec_2020.mp4) and keep the [muxsa block diagram](doc/muxsa-blockdiagram.png) in mind. +This is the step-by-step documentation how to use muxsa. For an overview on muxsa please watch the [Demonstration video (a.k.a. the making of Network Security 2020)](https://nks-devel3.rus.uni-stuttgart.de/muxsa/making_of_netsec_2020.mp4) and keep the [muxsa block diagram](muxsa-blockdiagram.png) in mind. The author uses muxsa with Debian Linux 11 ("bullseye"). The muxsa scripts and the other software packages used are not very specific to this Linux @@ -47,7 +47,9 @@ The ```muxsa-kvm2png``` script will take screenshots, save them into numbered png files, and press PageDown, until the end of the presentation is reached. -You might want to create a configuration file: ```vi ~/.muxsarc``` +You might want to create a configuration file: + + user@linux:~$ vi ~/.muxsarc MUXSA_KVM2PNG_VM_NAME="win10-office" MUXSA_KVM2PNG_EXTRA_Y="26" MUXSA_KVM2PNG_BUGFIX_SHOOT_TWICE="1" @@ -87,7 +89,7 @@ and start ```muxsa-pv```. It will create a subdirectory ```presenter-view``` and create a files with the same name as in the parent directory, as a "presenter view" similar to -powerpoint, i.e. the current file on the left, the next file as a preview on +powerpoint, i.e. the current slide on the left, the next slide as a preview on the right. ## Record background narration @@ -133,7 +135,7 @@ sound reflections, but the audible difference was rather limited. ### Software drivers -Debian Linux 11 normally uses pulseaudio to route different audio streams +Debian Linux 11 normally uses ```pulseaudio``` to route different audio streams from microphones to applications and from applications to headsets or speakers, respecively, as well as for mixing streams and resampling different sample rates. While these functions are useful for desktop usage, @@ -179,15 +181,15 @@ The next settings depend on your voice and your preferences, but you may use these as a starting point for your own experiments. At the Motu M2 interface set * at the "IN 1L" side, where the microphone is plugged in - * GAIN to about "3 o'clock" + * GAIN to about "3 o'clock" position * Phantom power off (the red "48V" LED does not light up) * Direct monitoring on (the blue "MON" LED is lit) * at the "IN 2R" side, where no microphone is connected to - * GAIN to minimum, i.e., about "7 o'clock" + * GAIN to minimum, i.e., about "7 o'clock" position * Phantom power off (the red "48V" LED does not light up) * Direct monitoring off (the blue "MON" LED does not light up) * Monitor to minimum, i.e., big knob to about "7 o'clock" position -* Headphone volume (small knob at the very right) to about "3 o'clock" +* Headphone volume (small knob at the very right) to about "3 o'clock" position Adjust the boom arm such that the tip of the microphone points at a 45 degree angle to one corner of your mouth and that the microphone is very @@ -204,8 +206,8 @@ Hit stop when you are done. Hit the play button to listen to your recording. While listening to the recording and in particular while editing the recording (see below), it is wise to turn off the direct monitoring feature (blue button on the Motu M2), to make sure that -any sound picked up by the microphone (e.g., keyboard klicks) is not -mixed with the playback. +any sound picked up by the microphone (e.g., keyboard klicks) +at that time is not mixed with the playback. While you are recording or while you are listening to the playback, inspect the volume meter. While you are speaking, the volume bars should go most of @@ -228,34 +230,37 @@ Restart Audacity. Now you should find two named pipes: /tmp/audacity_script_pipe.from.1000 /tmp/audacity_script_pipe.to.1000 -(1000 is my user ID, yours might be different, see id -u). +(1000 is the author's user ID, yours might be different, see id -u). ### More efficient recording with muxsa-vr You can use a "wireless presenter", i.e., a small handheld transmitter, usually with a laser pointer, that is often used for giving presentations. -muxsa-vr receives the key strokes from that wireless presenter and sends +```muxsa-vr``` receives the key strokes from that wireless presenter and sends control commands simultaneously both to Audacity and geeqie, in order to make recording, playback for review, deleting and re-recording, setting labels with ascending slide numbers, switching to the next slide, etc. more convenient. -Start Audacity as described above. +Start ```audacity``` as described above. Start the ```geeqie``` image viewer in the directory with the "presenter view" PNG files and go to the first slide. -Start a console/xterm window with a shell and start muxsa-vr there. +Start a console/xterm window with a shell and start ```muxsa-vr``` there. Keep the mouse/keyboard focus in that window. Press the "i" key on -the computer keyboard to initialize muxsa-vr. +the computer keyboard to initialize muxsa-vr. Then, -Pressing the "PageDown" key (usually the big right button) on the presenter -starts recording a clip, if idle, or stops recording while in recording -state. Pressing the "PageUp" key (usually the big left button) plays the -most recently recorded clip. Pressing the "F5/ESC" key (usually the small -left button), deletes the most recently recorded clip - if you made an error -and want to record it again. Pressing the "dot" key (usually the small right -button) moves on to the next slide. Further keys may be hit on the +* pressing the "PageDown" key (usually the big right button) on the +presenter starts recording a clip, if idle, or stops recording while in +recording state +* pressing the "PageUp" key (usually the big left button) plays the +most recently recorded clip +* pressing the "F5/ESC" key (usually the small left button), deletes the +most recently recorded clip - if you made an error and want to record it again. +* pressing the "dot" key (usually the small right +button) moves on to the next slide. +* Further keys may be hit on the computer's main keyboard to control muxsa-vr, press the "h" key for online help. @@ -357,7 +362,7 @@ use user@linux:~$ muxsa-pngaac2mp4 to assemble the final video named ```out.mp4```. A different output -filename can be given as parameter to muxsa-pngaac2mp4. +filename can be given as parameter to ```muxsa-pngaac2mp4```. ## Watch the video