Browse Source

Update documentation and info files

master
Nils 3 years ago
parent
commit
59914e1b79
  1. 2
      README.md
  2. 1
      documentation/english.adoc
  3. 1
      documentation/german.adoc
  4. 70
      documentation/laborejo.1
  5. 44
      documentation/manpageinclude.h2m
  6. 5
      documentation/out/english.html
  7. 5
      documentation/out/german.html

2
README.md

@ -19,6 +19,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/laborejo
# Installation and Starting

1
documentation/english.adoc

@ -88,6 +88,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..

1
documentation/german.adoc

@ -1059,6 +1059,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.

70
documentation/laborejo.1

@ -0,0 +1,70 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.13.
.TH LABOREJO "1" "April 2020" "Laborejo 2.0" "User Commands"
.SH NAME
Laborejo - MIDI sequencer based on classical music notation
.SH DESCRIPTION
usage: laborejo [\-h] [\-v] [\-s DIRECTORY] [\-p] [\-m] [\-V]
.PP
Laborejo \- Version 2.0 \- Copyright 2020 by Laborejo Software Suite \-
https://www.laborejo.org/laborejo
.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
Laborejo (Esperanto: Workshop) is a MIDI sequencer based on classical music notation.
Its main purpose is to compose and produce "traditional" music, such as instrumental pieces,
soundtracks and other music normally played back by samplers.
Unlike other notation editors Laborejo is not meant primarily to print out sheets of notation but
to create music for your computer: You get all the tools you know from other midi sequencers for
maximum fine control to get exactly the music you want!
Working in Laborejo is very fast and efficient by using a combination of midi input and typing.
.SH EXAMPLES
Start laborejo 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.
laborejo --save /tmp
Run without audio and midi. Skips all JACK checks. Used to just look at the GUI, e.g. to make screenshots
laborejo --mute
.SH "REPORTING BUGS"
https://www.laborejo.org/bugs
.SH COPYRIGHT
Laborejo 2.0 - Copyright 2020
Laborejo Software Suite
https://www.laborejo.org/
.SH "SEE ALSO"
The full documentation for Laborejo is maintained as a multi-lingual html site to your systems doc-dir.
For example:
xdg-open file:///usr/share/doc/laborejo/index.html
The documentation can also be found online https://www.laborejo.org/documentation/laborejo

44
documentation/manpageinclude.h2m

@ -0,0 +1,44 @@
[name]
Laborejo - MIDI sequencer based on classical music notation
[usage]
Laborejo (Esperanto: Workshop) is a MIDI sequencer based on classical music notation.
Its main purpose is to compose and produce "traditional" music, such as instrumental pieces,
soundtracks and other music normally played back by samplers.
Unlike other notation editors Laborejo is not meant primarily to print out sheets of notation but
to create music for your computer: You get all the tools you know from other midi sequencers for
maximum fine control to get exactly the music you want!
Working in Laborejo is very fast and efficient by using a combination of midi input and typing.
[Reporting bugs]
https://www.laborejo.org/bugs
[copyright]
Laborejo 2.0 - Copyright 2020
Laborejo Software Suite
https://www.laborejo.org/
[examples]
Start laborejo 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.
laborejo --save /tmp
Run without audio and midi. Skips all JACK checks. Used to just look at the GUI, e.g. to make screenshots
laborejo --mute
[see also]
The full documentation for Laborejo is maintained as a multi-lingual html site to your systems doc-dir.
For example:
xdg-open file:///usr/share/doc/laborejo/index.html
The documentation can also be found online https://www.laborejo.org/documentation/laborejo

5
documentation/out/english.html

@ -608,6 +608,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>
@ -730,7 +733,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:38 +0200
Last updated 2020-04-12 23:24:05 +0200
</div>
</div>
</body>

5
documentation/out/german.html

@ -1936,6 +1936,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>
@ -2069,7 +2072,7 @@ Ansonsten starten Sie laborejo mit diesem Befehl, Sprachcode ändern, vom Termin
</div>
<div id="footer">
<div id="footer-text">
Last updated 2020-04-07 20:53:38 +0200
Last updated 2020-04-12 23:24:05 +0200
</div>
</div>
</body>

Loading…
Cancel
Save