HelpUpdate - various fixes in various files

* Fix mailing address + version + authors in HOWTO * Ordering in doc/README.md * Format in doc/quick start * Markdown consistency in doc/install * fix Intralinks in various
2025-12-05 15:30:02 +01:00 · 2019-06-24 10:13:59 +02:00
parent a2bd2538d6
commit 735a36fd04
6 changed files with 147 additions and 125 deletions
--- a/README.md
+++ b/README.md
@@ -124,7 +124,7 @@ make && sudo make install

 You can change the default FX parameter values by editing the files in `$HOME/.veejay/frei0r/` and `$HOME/.veejay/livido/`

-**See Also** : For more verbose information about plugins and FX check [How to Plugins](./veejay-current/veejay-server/doc/HowtoPlugins.md)
+**See Also** : For more verbose information about plugins and FX check [How to Plugins](./veejay-current/veejay-server/doc/HOWTO.plugins.md)

 ## Debugging

@@ -132,7 +132,7 @@ If you want to debug veejay-server (or if you want to submit a meaningful backtr

     ./configure --enable-debug

-see also : [How to debug](./veejay-current/veejay-server/doc/HowToDebugging.txt)
+see also : [How to debug](./veejay-current/veejay-server/doc/HOWTO.debugging.md)

 [//]: # ( comment : END Instalation section duplicated in /veejay-server/doc/Instalation)
 [//]: # ( WARNING : some URL/PATH have to be adapted )
@@ -141,7 +141,7 @@ see also : [How to debug](./veejay-current/veejay-server/doc/HowToDebugging.txt)

 ### Let's VJing Now...

-[__Veejay Quick start and play!__](./veejay-current/veejay-server/doc/README.quickstart) : start veejay, manually send VIMS messages, tricks to video fifo or some essentials of keyboards user interaction...
+[__Veejay Quick start and play!__](./veejay-current/veejay-server/doc/README.quickstart.md) : start veejay, manually send VIMS messages, tricks to video fifo or some essentials of keyboards user interaction...

 ## FEATURE OVERVIEW

@@ -178,7 +178,7 @@ see also : [README Video & Codecs](./veejay-current/veejay-server/doc/README.vid
 * All FX parameters can be animated
 * Mix up to two layers per FX slot

-see also : [How to Plugins](./veejay-current/veejay-server/doc/HowtoPlugins.md)[README alpha](./veejay-current/veejay-server/doc/README.alpha.md)
+see also : [HOWTO plugins](./veejay-current/veejay-server/doc/HOWTO.plugins.md), [README alpha](./veejay-current/veejay-server/doc/README.alpha.md)

 ### Editing

@@ -246,7 +246,7 @@ see also : [How to video wall](./veejay-current/veejay-server/doc/video-wall.md)
 * Support for GMIC plugins
 * Android client!

-see also : [How to Plugins](./veejay-current/veejay-server/doc/HowtoPlugins.md), [README odroid-xu3](./veejay-current/veejay-server/doc/README.odroid-xu3)
+see also : [How to Plugins](./veejay-current/veejay-server/doc/HOWTO.plugins.md), [README odroid-xu3](./veejay-current/veejay-server/doc/README.odroid-xu3)

 [//]: # ( comment : END Feature section DUPLICATE in /veejay-server/doc/veejay-HOWTO.md)
 [//]: # ( WARNING : some URL/PATH have to be adapted )
--- a/veejay-current/veejay-server/doc/Installation.md
+++ b/veejay-current/veejay-server/doc/Installation.md
@@ -5,11 +5,11 @@
 ## Get all the dependencies

 First, make sure you system is up-to-date, and install (in debian like system) the required dependencies with:
-```bash
-sudo apt-get install build-essential autoconf automake libtool m4 gcc libjpeg62-dev \
-libswscale-dev libavutil-dev libavcodec-dev libavformat-dev libx11-dev  \
-gtk-3.0-dev libxml2-dev libsdl2-dev libjack0 libjack-dev jackd1
-```
+
+    $ sudo apt-get install build-essential autoconf automake libtool m4 gcc libjpeg62-dev \
+    libswscale-dev libavutil-dev libavcodec-dev libavformat-dev libx11-dev  \
+    gtk-3.0-dev libxml2-dev libsdl2-dev libjack0 libjack-dev jackd1
+

 ## Build the veejay's applications

@@ -17,17 +17,17 @@ Veejay is divided into multiple packages. Each must be build separately and in a

 1. [veejay-core](https://github.com/c0ntrol/veejay/tree/master/veejay-current/veejay-core) (__required__)
 2. [veejay-server](https://github.com/c0ntrol/veejay/tree/master/veejay-current/veejay-server) (__required__)
-3. [veejay_client](https://github.com/c0ntrol/veejay/tree/master/veejay-current/veejay-client) (*optional*)
+3. [veejay-client](https://github.com/c0ntrol/veejay/tree/master/veejay-current/veejay-client) (*optional*)
 4. [veejay-utils](https://github.com/c0ntrol/veejay/tree/master/veejay-current/veejay-utils) (*optional*)
 5. [plugin-packs](https://github.com/c0ntrol/veejay/tree/master/veejay-current/plugin-packs) (*optional*)

 For __each package__, run the triptich commands of the *GNU build system* (for a quick start you can build the first two):

-```bash
- ./autogen.sh
- ./configure
- make -j$(nproc) && sudo make install
-```
+
+    $ ./autogen.sh
+    $ ./configure
+    $ make -j$(nproc) && sudo make install
+
 __IMPORTANT :__ in some configuration you should have to __manually build__ the __shared libraries cache__ just after the __first veejay-core__ installation (ex `sudo ldconfig` or similar)

 __Configure :__ You do not need to pass any parameters to `./configure` for veejay to be optimized with the current cpu-type.
@@ -48,16 +48,14 @@ But the quick answer would be:

 ### 1. Start one or more Veejay servers:

-```
-veejay --clip-as-sample my-movie-A.avi
-veejay -p 4490 -g my-movie-B.avi
-```
+    $ veejay --clip-as-sample my-movie-A.avi
+    $ veejay -p 4490 -g my-movie-B.avi
+

 ### 2. Start and autoconnect the veejay graphical interface:

-```
-reloaded -a
-```
+    $ reloaded -a
+

 ## Building and Configuring plugins

@@ -67,6 +65,7 @@ But you can have more !
 ### frei0r

 Veejay looks in a few common locations to find the [frei0r plugins pack](https://frei0r.dyne.org/):
+
 * /usr/local/lib/frei0r-1
 * /usr/lib/frei0r-1
 * /usr/lib64/frei0r-1
@@ -84,26 +83,26 @@ There are several plugin-packs available for veejay: [plugin-packs](https://gith


 To compile and install a plugin-pack:
-```bash
-cd plugin-packs/lvdgmic
-./autogen.sh
-./configure
-make && sudo make install
-```
+
+    $ cd plugin-packs/lvdgmic
+    $ ./autogen.sh
+    $ ./configure
+    $ make && sudo make install
+

 ### Default parameter values

 You can change the default FX parameter values by editing the files in `$HOME/.veejay/frei0r/` and `$HOME/.veejay/livido/`

-**See Also** : For more verbose information about plugins and FX check [How to Plugins](./HowtoPlugins.md)
+**See Also** : For more verbose information about plugins and FX check [How to Plugins](./HOWTO.plugins.md)

 ## Debugging

 If you want to debug veejay-server (or if you want to submit a meaningful backtrace), build with:

-     ./configure --enable-debug
+    ./configure --enable-debug

-see also : [How to debug](./HowToDebugging.txt)
+see also : [How to debug](./HOWTO.debugging.md)


 [//]: # ( comment : END installation section duplicated in /README.md)
--- a/veejay-current/veejay-server/doc/README.android.md
+++ b/veejay-current/veejay-server/doc/README.android.md
@@ -21,4 +21,4 @@ Veejay's server address is encoded as string `HOST:PORTNUMBER`, for example

 The QR image is regenerated at each startup and placed in `$HOME/.veejay` as `QR-3490.png`

-See also [How to Compile](./HowtoCompile.txt) for precise compilation information.
+See also [How to Compile](./HOWTO.compile.md) for precise compilation information.
--- a/veejay-current/veejay-server/doc/README.md
+++ b/veejay-current/veejay-server/doc/README.md
@@ -1,21 +1,33 @@
-* [COPYING](./COPYING)
-* Extensive information on building veejay software packages [HOW TO compile](./HOWTO.compile.md)
-* Report a bug ? contribute to a better veejay ? [HOW TO debugging](./HOWTO.debugging.md)
-* All you need to configure external video plugins - [HOW TO plugins](./HOWTO.plugins.md)
-* [HowtoUbuntu.txt](./HowtoUbuntu.txt)
-* [HowtoVeejay-PureData.html](./HowtoVeejay-PureData.html)
-* [INSTALL](./INSTALL)
-* [Installation](./Installation.md)
-* [NET.txt](./NET.txt)
-* Support for alpha channel compositing - [README.alpha](./README.alpha.md)
-* [README.android](./README.android.md)
-* [README.audio](./README.audio)
-* What codec choose and how - [README.video codec](./README.video-codec.md)
-* Memory concern with veejay - [README.memory](./README.memory.md)
-* Performance tips - [README.performance](./README.performance.md)
-* [README.quickstart](./README.quickstart)
-* [README.whatis](./README.whatis.md)
-* A verbose and deep description - [veejay-HOWTO](./veejay-HOWTO.md)
-* [video-wall.md](./video-wall.md)
-* VIMS is Veejay's IMS (Internal Message System) - [VIMS.md](./VIMS.md)
-* [YCbCr.txt](./YCbCr.txt)
+* [COPYING](./COPYING) : Veejay is free as GNU/GPL
+
+### First steps...
+* [README.whatis](./README.whatis.md) : Veejay is a realtime visual instrument
+* [Installation](./Installation.md) : From core to plugins install
+* [INSTALL](./INSTALL) : Generic install
+
+* [README quickstart](./README.quickstart.md) : Quick jump to basic playing
+
+### Going further in visuals and control
+* [veejay HOWTO](./veejay-HOWTO.md) : A verbose and deep description
+* [HOWTO plugins](./HOWTO.plugins.md) : All you need to configure external video plugins
+* [README.alpha](./README.alpha.md) : Support for alpha channel compositing
+* [VIMS(./VIMS.md) : VIMS is Veejay's IMS (Internal Message System)
+* [video wall](./video-wall.md) : How to split ouput in multiple screens
+
+* [How to Veejay PureData](./HowtoVeejay-PureData.html)
+
+### Adapt your veejay
+* [HOW TO compile](./HOWTO.compile.md) : Extensive information on building veejay software packages
+* [HOW TO debugging](./HOWTO.debugging.md) : Report a bug ? contribute to a better veejay ?
+
+* [How to Ubuntu](./HowtoUbuntu.txt)
+
+### Special concerns : codecs and hardware stuff
+* [README audio](./README.audio)
+* [README video codec](./README.video-codec.md) : What codec choose and how
+* [YCbCr](./YCbCr.txt)
+* [README memory](./README.memory.md) : Memory concern with veejay
+* [README performance](./README.performance.md) : Performance tips
+* [README NETWORK](./NET.txt)
+
+* [README android](./README.android.md)
--- a/veejay-current/veejay-server/doc/README.quickstart.md
+++ b/veejay-current/veejay-server/doc/README.quickstart.md
@@ -1,110 +1,114 @@
+                                                                                                              
+        //    ) )                                             //   ) )                                        
+       //    / /                ( )      ___       / ___     ((         __  ___     ___        __     __  ___ 
+      //    / /     //   / /   / /     //   ) )   //\ \        \\        / /      //   ) )   //  ) )   / /    
+     //  \ \ /     //   / /   / /     //         //  \ \         ) )    / /      //   / /   //        / /     
+    ((____\ \     ((___( (   / /     ((____     //    \ \ ((___ / /    / /      ((___( (   //        / /      

-It is advised to read the howto and the MAN page as well. 

+_It is advised to read the howto and the MAN page as well._
+
+### Launch and select source
 You can launch veejay with

-$ veejay -d
+    $ veejay -d

 This should show some moving black/white footage. Most of the effects will be boring on this footage,
 so you can try to open your video4linux device with

-sayVIMS "240:0 1;" (device 0, channel 1)
+    $ sayVIMS -m "240:0 1;" (device 0, channel 1)

-Or, to use mplayer, create a FIFO first:
+or your dv1394 firewire device.

-$ mkfifo stream.yuv
+    $ sayVIMS -h localhost -p 3490 -m "241:63;"

-Use something like 'mplayer -vo yuv4mpeg -x 352 -y 288 -vf scale -zoom' 
+
+To use mplayer, create a FIFO first:
+
+    $ mkfifo stream.yuv
+
+Use something like `mplayer -vo yuv4mpeg -x 352 -y 288 -vf scale -zoom`

 and open the stream in veejay's console:

-sayVIMS "243:stream.yuv;"
+    $ sayVIMS -m "243:stream.yuv;"

 Move your mouse pointer to the SDL window (so it dissapears) and press 'ESC' to
 switch from the dummy footage to the last created or played video stream. 

-Try loading an AVI file with something like:
+Try loading an AVI file with something like:  
+_(mjpeg-video-file.avi __must be__ encoded for veejay, see [codec](./README.video-codec.md)_

-$ veejay -v mjpeg-video-file.avi
+    $ veejay -v -g mjpeg-video-file.avi

-The '-v' commandline option generates extra debugging output.
+The `-v` commandline option generates extra debugging output.  
+The `-g` load clips has samples.

 By default, veejay uses a SDL window for displaying video. You can specify veejay to
 write to STDOUT :

-$ veejay -O3 -o stdout mjpeg-video-file.avi | yuvplay
+    $ veejay -O3 -o stdout mjpeg-video-file.avi | yuvplay

-In this mode, the console input and SDL keyboard functions are disabled. You must use
-the sendVIMS commandline utility to interact with veejay or with an alternative utility like sendOSC.
-Refer to the howto for more information.
+__In this mode__, the console input and SDL keyboard functions __are disabled__. You must use
+the `sayVIMS` commandline utility to interact with veejay or with an alternative utility like sendOSC. Refer to the howto [VIMS](./VIMS.md) for more information.
+
+Let's discover with some SDL keyboard functions :
+
+### Sampling and select sample
+Once you have loaded veejay, preferably with a videofile :
+
+* press [KP 1] , [left bracket], [KP 3], [right bracket] , [F1]
+
+This will create a virtual clip (in memory) from your entire video file.
+
+* If you press [KP divide] , veejay will return to plain video mode so you can create more clips.
+* If you press [ESC] , veejay will switch from playing streams to playing clips or vice versa
+
+* Press [F1] to [F12] to select a clip,
+* Press [1] to [9] to select a bank (1 = clips 1 to 12,  2 = clips 12 to 24, etc )
+
+### Add an effect
+Once you are playing a clip/stream, simply press
+
+* [Cursor UP] , [ENTER]
+
+To add an effect in the current effect chain entry.
+
+If you add a video effect, try pressing [-] and [=] to select another channel and [/] to toggle between clip/stream sources


-Once you have loaded veejay (preferably with a videofile)
+### Effect chain
+Veejay supports chaining of effects since day 0, a number of keys have some importance :

-  (see man veejay for an overview of both console input and SDL keyboard events)
+* [-] ,[=] and [/] , select previous / next channel and toggle sources
+* [END] enable / disable the chain
+* [KP -] select the previous entry
+* [KP +] select the next entry
+* [ALT]+[END] enable / disable the current selected entry
+* [ENTER] add an effect from the list to the chain
+* [DEL] remove an effect from the chain

-   press 'KP 1' , 'left bracket', 'KP 3', 'right bracket' , 'F1'
+### More keys ?
+Also, you can press [HOME] to see clip or stream information.

-   This will create a virtual clip (in memory) from your entire video file.
+Try the keys [A] to [L] to increase/decrease playback speed.  
+Try the keys combinaison [ALT] + [A] to [L] to increase/decrease frame repetition.

-   If you press 'KP divide' , veejay will return to plain video mode so you can create more clips.
-   If you press 'ESC' , veejay will switch from playing streams to playing clips or vice versa
+_See __man veejay__ for an overview of both console input and SDL keyboard events_

-   Press F1 to F12 to select a clip,
-   press 1 to 9 to select a bank (1 = clips 1 to 12,  2 = clips 12 to 24, etc )
-
-   Once you are playing a clip/stream, simply press
-     'Cursor UP' , 'ENTER'
-
-   If you add a video effect, try pressing '-' and '=' to select another channel and '/' to
-   toggle between clip/stream sources
-
-
-   Veejay supports chaining of effects since day 0, a number of keys have some importance
-
-	'-' ,'=' and '/'
-
-	'END' for enabling/disabling the chain
-	'KP -' for selecting the previous entry
-	'KP +' for selecting the next entry
-        'ALT+END' for enabling/disabling the current selected entry
-	'ENTER' for adding an effect from the list to the chain
-	'DEL'  for removing an effect from the chain
-	
- 
-   Also, you can press 'HOME' to see clip or stream information.
-
-   Try the keys 'A' to 'L' to increase/decrease playback speed.
-
-
-Also, you can load some predefined custom effect chain templates that
-will put a template on your effect chain when you press SHIFT + some alphabetic character 
+### Load custom chain
+Also, you can load some predefined custom effect chain templates that will put a
+template on your effect chain when you press SHIFT + some alphabetic character.

 First, load an action file

-$ veejay -l test/livecinema/action-file.xml
+    $ veejay -l test/livecinema/action-file.xml

 Or in veejay's console

 > al test/livecinema/action-file.xml

-(activate a stream or clip and) press SHIFT+S or SHIFT+B or SHIFT+ ... 
-
-
-Except all that, try this:
-
-
-sayVIMS -h localhost -p 3490 "241:63;"
-(press F7)
-
-to open your dv1394 firewire device
-
-or
-sayVIMS -h localhost -p 3490 "240:0 1;"
-(press F7)
-
-to open your video4linux device /dev/video0, channel 1
-
+(activate a stream or clip and) press [SHIFT]+[S] or [SHIFT]+[B] or [SHIFT]+ ...


 Enjoy!
--- a/veejay-current/veejay-server/doc/veejay-HOWTO.md
+++ b/veejay-current/veejay-server/doc/veejay-HOWTO.md
@@ -3,6 +3,8 @@ Veejay HOWTO

 Matthijs van Henten ( cola(AT)cb3rob(dot)net )  
 Niels Elburg ( nielselburg(AT)yahoo(dot)de )  
+Jérôme Blanchi ( d.j.a.y(AT)free(dot)fr )  
+
 v1.0, 30 March 2003  
 v1.1, 22 June 2003  
 v1.2, 26 August 2003  
@@ -12,6 +14,7 @@ v2.0, 25 July 2004
 v2.1 27 January 2005  
 v2.2 22 April 2005  
 v3.0 8 March 2008  
+v3.1 21 June 2019  

 ------------------------------------------------------------------------

@@ -103,6 +106,7 @@ about veejay and trying it out.
 **Version 2.1** Updated Howto to match version 0.7.2</br>
 **Version 2.2** Updated Howto to match version 0.8</br>
 **Version 3.0** Large rewrite to match version 1.1</br>
+**Version 3.1** Large rewiew and update</br>

 <span id="1.5">1.5 New versions of this document</span>
 -------------------------------------------------------
@@ -118,7 +122,7 @@ know and we'll include a reference to it here.

 We rely on you, the reader, to make this HOWTO usefull. If you have any
 suggestions, corrections, or comments, translations, please send them to us (
-[veejay-users@lists.sourceforge.net](veejay-users@lists.sourceforge.net)
+[veejay-discussion@googlegroups.com](veejay-discussion@googlegroups.com)
 ), and we will try to incorporate them in the next revision. Please add
 'HOWTO veejay' to the Subject-line of the mail.  

@@ -172,6 +176,8 @@ Veejay consists out of several packages:
 </tbody>
 </table>

+See also [README.whatis](./README.whatis.md)
+
 <span id="2.1">2.1 Features</span>
 ----------------------------------
 [//]: # ( comment : BEGIN Feature section DUPLICATE in /README.md)
@@ -374,7 +380,7 @@ $ make -j$(nproc)
 ```
 Followed by
 ```
-# sudo make install && sudo ldconfig
+# make install && ldconfig
 ```

 Repeat the same process (appart `ldconfig`) for veejay-server and other needed packages.
@@ -1010,8 +1016,9 @@ as packages you can use in combination with veejay.
 <span id="6.2">6.2 Mailing Lists</span>
 ---------------------------------------

-There is a mailing list for veejay which is hosted by Sourceforge. The
-address is <veejay-users@lists.sourceforge.net>
+There is a mailing list for veejay which is hosted by google groups.  
+You can access to the archive at https://groups.google.com/forum/#!forum/veejay-discussion.  
+The address is `veejay-discussion[AT]googlegroups[DOT]com`  

 <span id="6.3">6.3 Veejay developer's lounge</span>
 ---------------------------------------------------