aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/optionsdialog.html4
-rw-r--r--doc/qmidiplayer12
-rw-r--r--doc/troubleshooting.html2
-rw-r--r--doc/visualization.html28
4 files changed, 24 insertions, 22 deletions
diff --git a/doc/optionsdialog.html b/doc/optionsdialog.html
index 24a6ca7..b473b91 100644
--- a/doc/optionsdialog.html
+++ b/doc/optionsdialog.html
@@ -81,11 +81,11 @@
</ul>
<img src="../img/options5.png" width="440"><br>
Plugin manager. View details of plugins, enable or disable them here.<br>
- Enabled plugin list is applied after a restart.<br>
+ Changes in this page require a restart to take effect. New plugins are enabled by default.<br>
Plugin scanning follows the order below:
<ul>
<li>(*nix) /usr/lib/qmidiplayer</li>
- <li>The folder containing QMidiPlayer's executable file.</li>
+ <li>a folder named "plugins" in the folder containing QMidiPlayer's executable file.</li>
</ul>
<br><a href="index.html">Return</a>
</div>
diff --git a/doc/qmidiplayer b/doc/qmidiplayer
index 8dacdb1..4b318cd 100644
--- a/doc/qmidiplayer
+++ b/doc/qmidiplayer
@@ -1,15 +1,17 @@
.\" Manpage for qmidiplayer.
-.TH man 1 "29 Dec 2016" "0.8.3" "qmidiplayer man page"
+.TH man 1 "04 Dec 2019" "0.8.7" "qmidiplayer man page"
.SH NAME
-qmidiplayer \- Plays midi file
+qmidiplayer \- A midi file player
.SH SYNOPSIS
qmidiplayer [Options] [Midi Files]
.SH DESCRIPTION
QMidiPlayer is a cross-platform midi file player based on libfluidsynth and Qt.
.SH OPTIONS
Possible options are:
- -l, --load-all-files Load all files from the same folder.
- --help Show this help and exit.
- --version Show this version information and exit.
+ -h, --help Displays this help.
+ -v, --version Displays version information.
+ --plugin <plugin library> Load a plugin from <plugin library>.
+ -l, --load-all-files Load all files from the same folder.
+
.SH AUTHOR
Chris Xiong (chirs241097@gmail.com)
diff --git a/doc/troubleshooting.html b/doc/troubleshooting.html
index 34b50b2..7caf8be 100644
--- a/doc/troubleshooting.html
+++ b/doc/troubleshooting.html
@@ -159,7 +159,7 @@ The data at memory address 0x000001d8 could not be read.
0x69bf6fd4 from [unknown module] in BaseThreadInitThunk (No symbols)
0x6b97cf31 from [unknown module] in RtlUserThreadStart (No symbols)
</pre>
- Append that to your issue report (make sure it doesn't contain any personal stuff first).
+ Append that to your issue report (make sure it doesn't contain any personal data first).
For Linux users, you usually already have a coredump for the crash. Please refer to the
documentation of your distribution for how to take a back trace from that coredump.
</p>
diff --git a/doc/visualization.html b/doc/visualization.html
index 3507985..6ad44dd 100644
--- a/doc/visualization.html
+++ b/doc/visualization.html
@@ -30,18 +30,18 @@
To use the visualization, click the Visualization button in the main window.<br>
The visualization plugin adds two new option tabs.
<h3>Controls</h3>
-<pre>
- forward
- | ↱Hold left mouse button and drag:
- up | down ┌──┬──┐ Adjust viewport.
- ↓ ↓ ↓ │ │ │
- Q W E R←reset viewport ├──┴──┤
- A S D │ │
- ↑ ↑ ↑ │ │
-left | right ← → │ │
- | Seek left/right └─────┘
- backward (Hold shift to seek 5% instead of 1%)
-</pre>
+ <ul>
+ <li>W: move camera forward</li>
+ <li>A: move camera left</li>
+ <li>S: move camera backward</li>
+ <li>D: move camera right</li>
+ <li>Q: move camera up</li>
+ <li>E: move camera down</li>
+ <li>Left arrow key: seek backward 1%</li>
+ <li>Right arrow key: seek forward 1%</li>
+ <li>Shift: seed 5% instead of 1%</li>
+ <li>Left mouse button: hold and drag to orient the camera</li>
+ </ul>
<h3>Options</h3>
The options listed here are applied after closing and reopening the visualization.
<ul>
@@ -70,8 +70,8 @@ left | right ← → │ │
<li>Save Viewport: Restore last camera configuration when the visualization is started.</li>
<li>Window Width/Height: Change the window size. If the size equals to your screen size, the visualization will start in fullscreen mode.</li>
<li>FPS: FPS limit of the visualization.</li>
- <li>Supersampling: Supersample anti-aliasing. 1 means no SSAA.</li>
- <li>Multisampling: Multisample anti-aliasing. 0 means no MSAA.</li>
+ <li>Supersampling: Supersample anti-aliasing for the 3D visualization scene. 1 means no SSAA.</li>
+ <li>Multisampling: Multisample anti-aliasing for the 3D visualization scene. 0 means no MSAA.</li>
<li>FOV: Field of view.</li>
<li>OSD Position: Change position of the on screen display, or simply disable it.</li>
<li>Font size: Change font size used by the visualization. Useful for HiDPI screens.</li>