Commit c9f1636c authored by Yvan Masson's avatar Yvan Masson
Browse files

Improve documentation

- How to debug
- Fix table of contents
parent 5a7b48f5
...@@ -46,8 +46,12 @@ can then easily provide help to non-tech people running Windows (≥ XP) or Linu ...@@ -46,8 +46,12 @@ can then easily provide help to non-tech people running Windows (≥ XP) or Linu
- [Usage](#usage) - [Usage](#usage)
- [Release policy](#release-policy) - [Release policy](#release-policy)
- [Frequently asked questions](#frequently-asked-questions) - [Frequently asked questions](#frequently-asked-questions)
- [Icon is not displayed when running the Linux client](icon-is-not-displayed-when-running-the-Linux-client) - [Debugging](#debugging)
- [How to run the VNC client on your computer and not on the server](how-to-run-the-VNC-client-on-your-computer-and-not-on-the-server) - [On the intermediate server](#on-the-intermediate-server)
- [On the Linux client](#on-the-linux-client)
- [On the Windows client](#on-the-windows-client)
- [Icon is not displayed when running the Linux client](#icon-is-not-displayed-when-running-the-Linux-client)
- [How to run the VNC client on your computer and not on the server](#how-to-run-the-VNC-client-on-your-computer-and-not-on-the-server)
- [License](#license) - [License](#license)
...@@ -379,7 +383,8 @@ cp ~/RemoteHelpBuilder/Linux-client/variables ~/my-remote-help-tool/variables ...@@ -379,7 +383,8 @@ cp ~/RemoteHelpBuilder/Linux-client/variables ~/my-remote-help-tool/variables
You must now edit `~/my-remote-help-tool/variables` to suit your You must now edit `~/my-remote-help-tool/variables` to suit your
needs. All variables in this shell script will be used to feed the main script, needs. All variables in this shell script will be used to feed the main script,
`linux-client`. As usual in shell scripts, be very careful to quote variables `linux-client`. As usual in shell scripts, be very careful to quote variables
and to escape quotes with backslashes (`\"`). You can use `\n` or `\t`. and to escape double quotes with backslashes (`\"`). You can use `\n` or `\t` to
print line return or tabulation respectively.
Ensure these two files have execute rights. Ensure these two files have execute rights.
...@@ -726,6 +731,33 @@ modified. ...@@ -726,6 +731,33 @@ modified.
# Frequently asked questions # Frequently asked questions
## Debugging
### On the intermediate server
You can check what OpenSSH server logs about the SSH connection in
`/var/log/auth.log`. If the SSH connection is successful, you can monitor if the
VNC server is listening with `lsof -i | grep 5900` (as root).
### On the Linux client
You can try to run the client from command line with verbose output:
```
sh -x /usr/bin/my-remote-help-tool
```
### On the Windows client
While running the client, open `%TEMP%` (usually
`C:\Users\username\AppData\Local\Temp\`) and read the content of the files
called `plink-stdout.log` and `plink-stderr.log`.
Once the SSH connection established, you can also check if the UltraVNC server
is running, either in the application tray or using the task manager.
## Icon is not displayed when running the Linux client ## Icon is not displayed when running the Linux client
If your home directory contains a directory with the exact same name of If your home directory contains a directory with the exact same name of
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment