comparison README @ 181:a566f654929e

README update: - Sortilège shorcuts have been replaced by Primitivus shortcuts - Credits updated
author Goffi <goffi@goffi.org>
date Mon, 16 Aug 2010 21:59:52 +0800
parents a5b5fb5fc9fd
children 92e4ddd580ae
comparison
equal deleted inserted replaced
180:fdb961f27ae9 181:a566f654929e
34 SàT is a XMPP (Jabber) client, made on a daemon/frontend architecture. Its aim is not only to be an instant messagery client: XMPP offer a lot more, and differents tools will come in the future. 34 SàT is a XMPP (Jabber) client, made on a daemon/frontend architecture. Its aim is not only to be an instant messagery client: XMPP offer a lot more, and differents tools will come in the future.
35 35
36 For the moment, the frontends are: 36 For the moment, the frontends are:
37 37
38 * wix: a wxwidget frontend, the main graphical frontend 38 * wix: a wxwidget frontend, the main graphical frontend
39 * sortilège: a ncurses client, for screen lovers 39 * primitivus: a console interface client, for screen lovers
40 * jp: the command line toolkit. The tool for geeks by geeks 40 * jp: the command line toolkit. The tool for geeks by geeks
41 41
42 other frontends planed in the near future: 42 other frontends planed in the near future:
43 43
44 * a web frontend 44 * a web frontend
59 59
60 60
61 61
62 ** Misc ** 62 ** Misc **
63 63
64 -- Shortcuts for sortilège (temporary): 64 -- Shortcuts for Primitivus (temporary):
65 C-L: access contact list (enter to valid) 65 C stands for "Ctrl"
66 F2: Show/Hide contact list 66 M stands for Meta wich is usually the "Alt" key
67 C-S: Short representation of contacts in chat window 67 S stands for "Shift"
68 C-C: Use colors... or not 68
69 C-T: Timestamp 69 ##GENERAL##
70 C-X: Leave 70 [tab] and/or arrows: change focus
71 C-x: Quit
72 M-m: (un)hide menu
73 C-n: see next notification
74 C-s: temporarly (un)hide popup window
75 F2: (un)hide the contact list
76
77 ##CHAT WINDOW##
78 M-p: (un)hide presents panel in group chat
79 M-t: (un)hide timestamp
80 M-n: (not) use short nicks
81 M-l: (un)hide window's decoration
82 M-s: change apperance of subject, switch between:
83 - one line (subject is clipped if too long)
84 - full subject displayed
85 - subject hidden
86
87 ##EDITION ZONE##
88 C-a or [home]: place the cursor at the begining of the line
89 C-e or [end]: place the cursor at the end of the line
90 C-k: kill (delete) everything at the right of the cursor
91 C-w: delete the last word
92 S-[tab]: Do context completion
93
94 Note that the mouse can be used
71 -- 95 --
72 96
73 SàT is the acronym (yes another one :( ) in tribute to the song Salut à Toi from the Bérurier Noir band. I recommand also the excelent cover from Les Ogres de Barback. 97 SàT is the acronym (yes another one :( ) in tribute to the song Salut à Toi from the Bérurier Noir band. I recommand also the excelent cover from Les Ogres de Barback.
74 jp stands for Jabber coPy or JumP. If you look well, you can also find my initials ;) 98 jp stands for "Jabber coPy" or "JumP". If you look well, you can also find my initials ;)
75 sortilège means "spell" in french, and it is ncurses based... 99 Primitivus is based on Urwid, and, according to their FAQ, "ur" is a german prefix for "ancestral or primal" (primitivus is latin word)
76 wix come of course from the WX of wxwidgets and just sound cool :). 100 wix come of course from the WX of wxwidgets and just sound cool :).
77 101
78 102
79 ** /!\ Privacy warning /!\ ** 103 ** /!\ Privacy warning /!\ **
80 104
82 The IP are not collected. Future releases will probably come with a warning about this and an easy way to avoid it. 106 The IP are not collected. Future releases will probably come with a warning about this and an easy way to avoid it.
83 107
84 108
85 ** Credit ** 109 ** Credit **
86 110
111 A big big thank to the authors/contributors of...
112
87 proxy65: 113 proxy65:
88 SàT (plugin_xep_0065) use nearly all the code from proxy65 (http://code.google.com/p/proxy65/) wich was coded by Dave Smith (2002-2004) and maintained by Fabio Forno (2007-2008). 114 SàT (plugin_xep_0065) use nearly all the code from proxy65 (http://code.google.com/p/proxy65/) wich was coded by Dave Smith (2002-2004) and maintained by Fabio Forno (2007-2008).
89 As the original MIT license allow, the code is reused and sublicensed until GPL v3 to follow the rest of the code. Thanks a lot to them ! 115 As the original MIT license allow, the code is reused and sublicensed until GPL v3 to follow the rest of the code.
90 116
91 progressbar: 117 progressbar:
92 SàT (jp) use ProgressBar (http://pypi.python.org/pypi/progressbar/2.2), a class coded by Nilton Volpato which allow the textual representation of progression. thanks to him 118 SàT (jp) use ProgressBar (http://pypi.python.org/pypi/progressbar/2.2), a class coded by Nilton Volpato which allow the textual representation of progression.
93 119
94 twisted: 120 twisted:
95 SàT is based on the twisted framework (http://twistedmatrix.com/trac/), a very great tools which offer a lot of protocols management. There are too many contributors to name them here, so take a look on the website :). Again, thanks to them 121 SàT is based on the twisted framework (http://twistedmatrix.com/trac/), a very great tools which offer a lot of protocols management. There are too many contributors to name them here, so take a look on the website :).
96 122
97 wokkel: 123 wokkel:
98 SàT use a library with high level enhancements on top of twisted, which is called wokkel (http://wokkel.ik.nu). Lot of thanks to Ralph Meijer and all other contributors. 124 SàT use a library with high level enhancements on top of twisted, which is called wokkel (http://wokkel.ik.nu). Lot of thanks to Ralph Meijer and all other contributors.
99 125
100 wxWidgets & wxPython: 126 wxWidgets & wxPython:
101 The Wix frontend is made with wxWidgets (www.wxwidgets.org) and its python version wxPython (wxPython), which is a really handy UI toolkit who works on most popular platforms. It can be found on probably all major Gnu/Linux distributions. as usual, thanks to the authors. 127 The Wix frontend is made with wxWidgets (www.wxwidgets.org) and its python version wxPython (wxPython), which is a really handy UI toolkit who works on most popular platforms. It can be found on probably all major Gnu/Linux distributions.
128
129 Urwid:
130 Primitivus is based on Urwid (http://excess.org/urwid/) which saved me a lot of time. It's really a great library to easily make a sophisticated interface.
102 131
103 pictures found in frontends/wix/images/crystal/: 132 pictures found in frontends/wix/images/crystal/:
104 These pictures come from Crystal clear, were made by Everaldo Coelho (www.everaldo.com) and YellowIcon (www.yellowicon.com). They are under LGPL V3 licence (see frontends/wix/images/COPYING.LESSER). Thanks to them. 133 These pictures come from Crystal clear, were made by Everaldo Coelho (www.everaldo.com) and YellowIcon (www.yellowicon.com). They are under LGPL V3 licence (see frontends/wix/images/COPYING.LESSER).
105 Found on http://commons.wikimedia.org/wiki/File:Crystal_Clear_app_browser.png and http://commons.wikimedia.org/wiki/File:Crystal_Clear_app_cache.png 134 Found on http://commons.wikimedia.org/wiki/File:Crystal_Clear_app_browser.png and http://commons.wikimedia.org/wiki/File:Crystal_Clear_app_cache.png
106 135
136 pictures found in frontend/wix/images/...:
137 The Tarot cards pictures come from the deck found on wikicommons (the script used to cut them is available at frontend/wix/images/split_card.sh), and available at http://upload.wikimedia.org/wikipedia/commons/8/8d/Tarotcards.jpg under Creative Commons BY-SA. The authors shown on the site are Piast and Svick. The splitted cards are, according to the license, available under the same conditions.
138
139 the powerfull ImageMagick (http://www.imagemagick.org/) is used by the script written to split the previously named picture.
140
107 and the others: 141 and the others:
108 and of course, nothing would be possible without Python (http://www.python.org/), Gnu and the Free Software Foundation (http://www.gnu.org, http://www.fsf.org/), the Linux Kernel (http://www.kernel.org/), and the coder of the tools I use like Vim (http://www.vim.org/), Mercurial (http://www.selenic.com/mercurial/wiki/), or all the KDE stuff (http://www.kde.org/ and of course http://amarok.kde.org/), etc. Thanks thanks thanks, thank to everybody in the Free (Libre) chain for making a part of the dream. 142 and of course, nothing would be possible without Python (http://www.python.org/), Gnu and the Free Software Foundation (http://www.gnu.org, http://www.fsf.org/), the Linux Kernel (http://www.kernel.org/), and the coder of the tools I use like Vim (http://www.vim.org/), Mercurial (http://www.selenic.com/mercurial/wiki/), or all the KDE stuff (http://www.kde.org/ and of course http://amarok.kde.org/), and also XFCE (http://www.xfce.org), etc. Thanks thanks thanks, thank to everybody in the Free (Libre) chain for making a part of the dream.
109 143
110 If I forgot any credit (and I probably have), please contact me (mail below) to fix it. 144 If I forgot any credit (and I probably have), please contact me (mail below) to fix it.
111 145
112 146
113 147