Browse Source

Update documentation and info files

master
Nils 3 years ago
parent
commit
f2b6e3787b
  1. 2
      README.md
  2. 1
      documentation/english.adoc
  3. 73
      documentation/fluajho.1
  4. 1
      documentation/german.adoc
  5. 48
      documentation/manpageinclude.h2m
  6. 5
      documentation/out/english.html
  7. 5
      documentation/out/german.html

2
README.md

@ -23,6 +23,8 @@ This README is just a short introduction. Consult the manual (see below) for mor
# Contact and Information
* Website https://www.laborejo.org
* Bugs and Issues: https://www.laborejo.org/bugs
* Git Repositories for all programs: https://git.laborejo.org
* Documentation and Manual https://www.laborejo.org/documentation/fluajho
# Installation and Starting

1
documentation/english.adoc

@ -135,6 +135,7 @@ If you find a bug in the program (or it runs too slow) please contact us in a wa
We are thankful for any help.
.How to contact us
* Report bugs and issues: https://www.laborejo.org/bugs
* Website: https://www.laborejo.org
* E-Mail: info@laborejo.org
* If you see the opportunity and know that a developer will read it also forums, social media etc..

73
documentation/fluajho.1

@ -0,0 +1,73 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.13.
.TH FLUAJHO "1" "April 2020" "Fluajho 1.5" "User Commands"
.SH NAME
Fluajho - SF2 sample player for for JACK based on Fluidsynth.
.SH DESCRIPTION
usage: fluajho [\-h] [\-v] [\-s DIRECTORY] [\-p] [\-m] [\-V]
.PP
Fluajho \- Version 1.5 \- Copyright 2020 by Laborejo Software Suite \-
https://www.laborejo.org/fluajho
.SS "optional arguments:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-v\fR, \fB\-\-version\fR
show program's version number and exit
.TP
\fB\-s\fR DIRECTORY, \fB\-\-save\fR DIRECTORY
Use this directory to save. Will be created or loaded
from if already present. Deactivates Non\-SessionManager support.
.TP
\fB\-p\fR, \fB\-\-profiler\fR
(Development) Run the python profiler and produce a
\&.cprof file at quit. The name will appear in your
STDOUT.
.TP
\fB\-m\fR, \fB\-\-mute\fR
(Development) Use a fake cbox module, effectively
deactivating midi and audio.
.TP
\fB\-V\fR, \fB\-\-verbose\fR
(Development) Switch the logger to INFO and print out
all kinds of information to get a high\-level idea of
what the program is doing.
.SH USAGE
"Fluajho" (with jh as in pleasure) means fluid in Esperanto. It is a simple sf2 soundfont
host/player for Linux. Behind the scenes the Fluidsynth library is at work, hence the name.
.sf2 is an old file format for making MIDI signals audible through virtual instruments, although it
is still in moderate use today.
Why does Fluajho exist? There are many soundfont players for Linux,
most of them even based on Fluidsynth. Fluajho was written for a clearly defined use case:
Load an .sf2 in the Non Session Manager and save the soundfont in the session directory.
This makes it possible to archive the session, for example as a backup or to share it.
You can load one soundfont file per Fluajho instance. Each instance holds 16 of the soundfonts
instruments that can be assigned to 16 MIDI channels. Finally connect external sequencers, such as
Laborejo, Patroneo or Vico, through JACK-Midi to play the instruments.
.SH EXAMPLES
Start fluajho through NSM, e.g. through Argodejo. This will take care of all
settings and save directories.
Other modes of operations, mostly for testing, are:
Run without session management and save in /tmp.
fluajho --save /tmp
Run without audio and midi. Skips all JACK checks. Used to just look at the GUI, e.g. to make screenshots
fluajho --mute
.SH "REPORTING BUGS"
https://www.laborejo.org/bugs
.SH COPYRIGHT
Fluajho 1.5 - Copyright 2020
Laborejo Software Suite
https://www.laborejo.org/
.SH "SEE ALSO"
The full documentation for Fluajho is maintained as a multi-lingual html site to your systems doc-dir.
For example:
xdg-open file:///usr/share/doc/fluajho/index.html
The documentation can also be found online https://www.laborejo.org/documentation/fluajho

1
documentation/german.adoc

@ -130,6 +130,7 @@ Falls Sie einen Fehler im Programm entdecken (oder es zu langsam läuft) melden
eine Art und Weise, die ihnen am besten passt.
.Kontaktmöglichkeiten
* Bugs und Probleme melden: https://www.laborejo.org/bugs
* Webseite: https://www.laborejo.org
* E-Mail: info@laborejo.org
* Wenn Sie die Gelegenheiten sehen und wissen, dass ein Entwickler es lesen wird sind auch Foren, Socialmedia etc. möglich.

48
documentation/manpageinclude.h2m

@ -0,0 +1,48 @@
[name]
Fluajho - SF2 sample player for for JACK based on Fluidsynth.
[usage]
"Fluajho" (with jh as in pleasure) means fluid in Esperanto. It is a simple sf2 soundfont
host/player for Linux. Behind the scenes the Fluidsynth library is at work, hence the name.
.sf2 is an old file format for making MIDI signals audible through virtual instruments, although it
is still in moderate use today.
Why does Fluajho exist? There are many soundfont players for Linux,
most of them even based on Fluidsynth. Fluajho was written for a clearly defined use case:
Load an .sf2 in the Non Session Manager and save the soundfont in the session directory.
This makes it possible to archive the session, for example as a backup or to share it.
You can load one soundfont file per Fluajho instance. Each instance holds 16 of the soundfonts
instruments that can be assigned to 16 MIDI channels. Finally connect external sequencers, such as
Laborejo, Patroneo or Vico, through JACK-Midi to play the instruments.
[Reporting bugs]
https://www.laborejo.org/bugs
[copyright]
Fluajho 1.5 - Copyright 2020
Laborejo Software Suite
https://www.laborejo.org/
[examples]
Start fluajho through NSM, e.g. through Argodejo. This will take care of all
settings and save directories.
Other modes of operations, mostly for testing, are:
Run without session management and save in /tmp.
fluajho --save /tmp
Run without audio and midi. Skips all JACK checks. Used to just look at the GUI, e.g. to make screenshots
fluajho --mute
[see also]
The full documentation for Fluajho is maintained as a multi-lingual html site to your systems doc-dir.
For example:
xdg-open file:///usr/share/doc/fluajho/index.html
The documentation can also be found online https://www.laborejo.org/documentation/fluajho

5
documentation/out/english.html

@ -682,6 +682,9 @@ We are thankful for any help.</p>
<div class="title">How to contact us</div>
<ul>
<li>
<p>Report bugs and issues: <a href="https://www.laborejo.org/bugs" class="bare">https://www.laborejo.org/bugs</a></p>
</li>
<li>
<p>Website: <a href="https://www.laborejo.org" class="bare">https://www.laborejo.org</a></p>
</li>
<li>
@ -804,7 +807,7 @@ The program is split in two parts. A shared "template" between the Laborejo Soft
</div>
<div id="footer">
<div id="footer-text">
Last updated 2020-04-07 20:53:27 +0200
Last updated 2020-04-12 23:23:52 +0200
</div>
</div>
</body>

5
documentation/out/german.html

@ -682,6 +682,9 @@ eine Art und Weise, die ihnen am besten passt.</p>
<div class="title">Kontaktmöglichkeiten</div>
<ul>
<li>
<p>Bugs und Probleme melden: <a href="https://www.laborejo.org/bugs" class="bare">https://www.laborejo.org/bugs</a></p>
</li>
<li>
<p>Webseite: <a href="https://www.laborejo.org" class="bare">https://www.laborejo.org</a></p>
</li>
<li>
@ -809,7 +812,7 @@ Ansonsten starten Sie fluajho mit diesem Befehl, Sprachcode ändern, vom Termina
</div>
<div id="footer">
<div id="footer-text">
Last updated 2020-04-07 20:53:27 +0200
Last updated 2020-04-12 23:23:52 +0200
</div>
</div>
</body>

Loading…
Cancel
Save