1
0
Fork 0

- made the program exits without invoke the debugger if the main

configuration file is not found;
- update documentation.
This commit is contained in:
cage 2020-05-16 11:24:11 +02:00
parent 9f155920ab
commit 2faf32800b
5 changed files with 129 additions and 38 deletions

View File

@ -17,7 +17,7 @@
- tree structure of messages; - tree structure of messages;
- subscriptions of hashtag; - subscriptions of hashtag;
- encrypted direct message (but see [[FAQ]]); - encrypted direct message (but see [[FAQ]]);
- no mentions notification, no knowlege of when or who favourited - no mentions notification, no knowledge of when or who favourited
your status; your status;
- No blocking or muting, the client can be configured to ignore - No blocking or muting, the client can be configured to ignore
a list of accounts. a list of accounts.
@ -166,10 +166,17 @@
* Privacy * Privacy
This software does collect nothing from its users in places The author of this software collect no user data informations.
different from their local computer.
But launching ~quick_quicklisp.sh~ will contact But this software is a client to connect and interact to one or more
remote computer. So potentially it could share a lot of
informations with other actors but just after the user allowed it to
do so.
It is the user reponsability to checks the privacy conditions of the
instance this software connect to.
Moreover launching ~quick_quicklisp.sh~ will contact
[[https://www.quicklisp.org/]], check the [[https://www.quicklisp.org/]], check the
[[https://beta.quicklisp.org/quicklisp.lisp][quicklisp sources]] for [[https://beta.quicklisp.org/quicklisp.lisp][quicklisp sources]] for
details. details.
@ -184,9 +191,45 @@
But, please take a minute to read the file [[./CONTRIBUTING.org]] But, please take a minute to read the file [[./CONTRIBUTING.org]]
* FAQ * FAQ
- are the encrypted messages secure?
No. First only a symmetric encryption scheme is implemented (so * 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?
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.
- Tinmop crashed! Where can i report that?
The issue tracker is here:
[[https://notabug.org/tinmop/issues/]]
Please also, if possible, send the backtrace of the process. To
print a backtrace just write ~backtrace~ when the debugger has
been invoked.
*Important note*
The backtrace can contains sensitive and personal information,
please always *carefully checks* the backtrace contents before
making this information public!
- Are the encrypted messages secure?
*No*. First only a symmetric encryption scheme is implemented (so
there is a problem of secure key exchanging). Moreover i am not a there is a problem of secure key exchanging). Moreover i am not a
crypto expert and probably i made something wrong. Note that i am crypto expert and probably i made something wrong. Note that i am
not claiming that the algorithm (AES256) or the implementation of not claiming that the algorithm (AES256) or the implementation of

View File

@ -20,8 +20,9 @@ Table of Contents
9. Privacy 9. Privacy
10. Contributing 10. Contributing
11. FAQ 11. FAQ
12. NO WARRANTY 12. FAQ
13. Acknowledgment 13. NO WARRANTY
14. Acknowledgment
@ -45,8 +46,8 @@ Table of Contents
• tree structure of messages; • tree structure of messages;
• subscriptions of hashtag; • subscriptions of hashtag;
• encrypted direct message (but see 11); • encrypted direct message (but see 11);
• no mentions notification, no knowlege of when or who favourited your • no mentions notification, no knowledge of when or who favourited
status; your status;
• No blocking or muting, the client can be configured to ignore a list • No blocking or muting, the client can be configured to ignore a list
of accounts. of accounts.
@ -220,10 +221,16 @@ Table of Contents
9 Privacy 9 Privacy
═════════ ═════════
This software does collect nothing from its users in places different The author of this software collect no user data informations.
from their local computer.
But launching `quick_quicklisp.sh' will contact But this software is a client to connect and interact to one or more
remote computer. So potentially it could share a lot of informations
with other actors but just after the user allowed it to do so.
It is the user reponsability to checks the privacy conditions of the
instance this software connect to.
Moreover launching `quick_quicklisp.sh' will contact
<https://www.quicklisp.org/>, check the [quicklisp sources] for <https://www.quicklisp.org/>, check the [quicklisp sources] for
details. details.
@ -248,9 +255,45 @@ Table of Contents
11 FAQ 11 FAQ
══════ ══════
• are the encrypted messages secure?
No. First only a symmetric encryption scheme is implemented (so 12 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?
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.
• Tinmop crashed! Where can i report that?
The issue tracker is here:
<https://notabug.org/tinmop/issues/>
Please also, if possible, send the backtrace of the process. To
print a backtrace just write `backtrace' when the debugger has been
invoked.
*Important note*
The backtrace can contains sensitive and personal information,
please always *carefully checks* the backtrace contents before
making this information public!
• Are the encrypted messages secure?
*No*. First only a symmetric encryption scheme is implemented (so
there is a problem of secure key exchanging). Moreover i am not a there is a problem of secure key exchanging). Moreover i am not a
crypto expert and probably i made something wrong. Note that i am crypto expert and probably i made something wrong. Note that i am
not claiming that the algorithm (AES256) or the implementation of not claiming that the algorithm (AES256) or the implementation of
@ -260,7 +303,7 @@ Table of Contents
So, please do not consider the encrypted message secure at all. So, please do not consider the encrypted message secure at all.
12 NO WARRANTY 13 NO WARRANTY
══════════════ ══════════════
tinmop: an humble mastodon client Copyright (C) 2020 cage tinmop: an humble mastodon client Copyright (C) 2020 cage
@ -282,7 +325,7 @@ Table of Contents
[http://www.gnu.org/licenses/] <http://www.gnu.org/licenses/> [http://www.gnu.org/licenses/] <http://www.gnu.org/licenses/>
13 Acknowledgment 14 Acknowledgment
═════════════════ ═════════════════
My deep thanks to the folks that provided us with wonderful SBCL and My deep thanks to the folks that provided us with wonderful SBCL and

View File

@ -212,7 +212,7 @@
- ~/etc/tinmop/shared.conf~: some default configuration not related to themes - ~/etc/tinmop/shared.conf~: some default configuration not related to themes
- ~/etc/tinmop/init.lisp~: system wide configuration - ~/etc/tinmop/init.lisp~: system wide configuration
- ~$HOME/.config/tinmop/init.lisp~: user configuration - ~$HOME/.config/tinmop/init.lisp~: user configuration
- ~$HOME/.local/share/tinmop/main.conf~: user configuration (simple format) - ~$HOME/.config/tinmop/main.conf~: user configuration (simple format)
* Privacy * Privacy

View File

@ -274,7 +274,7 @@ in the directory \fC$HOME/.local/share/tinmop/\fP.
.IP \(em 4 .IP \(em 4
\fC$HOME/.config/tinmop/init.lisp\fP: user configuration \fC$HOME/.config/tinmop/init.lisp\fP: user configuration
.IP \(em 4 .IP \(em 4
\fC$HOME/.local/share/tinmop/main.conf\fP: user configuration (simple format) \fC$HOME/.config/tinmop/main.conf\fP: user configuration (simple format)
.SH "Privacy" .SH "Privacy"
.PP .PP

View File

@ -376,6 +376,8 @@
purge-cache-days-offset) purge-cache-days-offset)
(defun load-config-file (&optional (virtual-filepath +conf-filename+)) (defun load-config-file (&optional (virtual-filepath +conf-filename+))
(handler-case
(progn
(let* ((file (res:get-config-file virtual-filepath)) (let* ((file (res:get-config-file virtual-filepath))
(tree (parse-config (fs:namestring->pathname file)))) (tree (parse-config (fs:namestring->pathname file))))
(loop for entry in tree do (loop for entry in tree do
@ -394,6 +396,9 @@
(declare (ignore rest)) (declare (ignore rest))
(setf *software-configuration* all)))))) (setf *software-configuration* all))))))
*software-configuration*)) *software-configuration*))
(error (e)
(format *error-output* "~a~%" e)
(os-utils:exit-program 1))))
;;;; end of parser ;;;; end of parser