cage/tinmop
1
0
Fork 0
mirror of https://codeberg.org/cage/tinmop/ synced 2025-02-01 04:26:47 +01:00
Code Issues

- updated FAQ.

Browse Source
This commit is contained in:
cage 2021-01-04 21:41:49 +01:00
parent 67837a858f
commit 42d3476cc3
2 changed files with 67 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
README.org
View File

@ -147,6 +147,10 @@ manager of your distribution (~apt~, ~yum~ etc).
$ tinmop
#+END_SRC
9. An error will be printed about a missing file
place a simple configuration file in one of the directory the software indicated.
See [[FAQ][the FAQ below]].
* Usage
See the command line options:
@ -213,6 +217,35 @@ manager of your distribution (~apt~, ~yum~ etc).
* FAQ
- I just tried to start the program for the first time but it give
me a weird error, what's wrong?
Did you wrote a configuration file before starting?
Tinmop expects a configuration file in your config directory
(usually ~$HOME/.config/tinmop/~). This file must contains at
least the username and the name of the instance you want to
connect.
Example :
#+BEGIN_SRC text
# a line starting with a '#' is a comment
# a file can be included in another with this directive:
# use "shared.conf"
# The server instance name
server = server address
# your username
username = username
#+END_SRC
If this file does not exists or is invalid tinmop will
refuse to start.
Please check the man page (tinmop(1)) for more information.
- The ~quick_quicklisp.sh~ script failed and refuse to start again,
what can I do?
@ -231,19 +264,6 @@ manager of your distribution (~apt~, ~yum~ etc).
I hope this will change in the future but this depends entirely
from the people are developing the server.
- I just tried to start the program for the first time but it give
me a weird error, what's wrong?
Did you wrote a configuration file before starting?
Tinmop expects a configuration file in your config directory
(usually ~$HOME/.config/tinmop/~). This file must contains at
least the username and the name of the instance you want to
connect. If this file does not exists or is invalid tinmop will
refuse to start.
Please check the man page (tinmop(1)) for more information.
- OK the program is running but how can i use it?
Press the key ~?~ to get a list of the available keys available.

46
README.txt
View File

@ -192,9 +192,15 @@ Table of Contents
│ $ tinmop
└────
9. An error will be printed about a missing file place a simple
configuration file in one of the directory the software indicated.
See [the FAQ below].
[dependencies] See section 3
[the FAQ below] See section 11
5 Usage
═══════
@ -282,6 +288,34 @@ Table of Contents
11 FAQ
══════
• I just tried to start the program for the first time but it give me
a weird error, what's wrong?
Did you wrote a configuration file before starting?
Tinmop expects a configuration file in your config directory
(usually `$HOME/.config/tinmop/'). This file must contains at least
the username and the name of the instance you want to connect.
Example :
┌────
│ # a line starting with a '#' is a comment
│
│ # a file can be included in another with this directive:
│ # use "shared.conf"
│
│ # The server instance name
│ server = server address
│
│ # your username
│ username = username
└────
If this file does not exists or is invalid tinmop will refuse to
start.
Please check the man page (tinmop(1)) for more information.
• The `quick_quicklisp.sh' script failed and refuse to start again,
what can I do?
@ -299,18 +333,6 @@ Table of Contents
I hope this will change in the future but this depends entirely from
the people are developing the server.
• I just tried to start the program for the first time but it give me
a weird error, what's wrong?
Did you wrote a configuration file before starting?
Tinmop expects a configuration file in your config directory
(usually `$HOME/.config/tinmop/'). This file must contains at least
the username and the name of the instance you want to connect. If
this file does not exists or is invalid tinmop will refuse to start.
Please check the man page (tinmop(1)) for more information.
• OK the program is running but how can i use it?
Press the key `?' to get a list of the available keys available.