README
author Nicolas Cornu <nicolas.cornu@ensi-bourges.fr>
Sun, 12 Sep 2010 18:20:53 +0200
changeset 167 97f93fa3cd95
parent 149 8c4129116d12
permissions -rw-r--r--
Change socks5.c to s5b.c in the headers and cmakelist
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
139
459b2503c1a3 Rename some stuff, create a README file, enable warnings in ./jingle
Nicolas Cornu <nicolas.cornu@ensi-bourges.fr>
parents: 0
diff changeset
     1
mcabber-jingle is a set of modules implementing:
459b2503c1a3 Rename some stuff, create a README file, enable warnings in ./jingle
Nicolas Cornu <nicolas.cornu@ensi-bourges.fr>
parents: 0
diff changeset
     2
* Jingle (XEP-0166), a XMPP extension for managing peer-to-peer sessions
149
8c4129116d12 Add some example usage in the README file
Nicolas Cornu <nicolas.cornu@ensi-bourges.fr>
parents: 139
diff changeset
     3
* Jingle File Transfer (XEP-0234), a Jingle application type for transferring
139
459b2503c1a3 Rename some stuff, create a README file, enable warnings in ./jingle
Nicolas Cornu <nicolas.cornu@ensi-bourges.fr>
parents: 0
diff changeset
     4
  files between two entities.
459b2503c1a3 Rename some stuff, create a README file, enable warnings in ./jingle
Nicolas Cornu <nicolas.cornu@ensi-bourges.fr>
parents: 0
diff changeset
     5
* Jingle In-Band Bytestreams (XEP-261), a Jingle transport method that sends data
459b2503c1a3 Rename some stuff, create a README file, enable warnings in ./jingle
Nicolas Cornu <nicolas.cornu@ensi-bourges.fr>
parents: 0
diff changeset
     6
  using the In-Band Bytestreams (IBB) protocol (XEP-0047).
459b2503c1a3 Rename some stuff, create a README file, enable warnings in ./jingle
Nicolas Cornu <nicolas.cornu@ensi-bourges.fr>
parents: 0
diff changeset
     7
  
459b2503c1a3 Rename some stuff, create a README file, enable warnings in ./jingle
Nicolas Cornu <nicolas.cornu@ensi-bourges.fr>
parents: 0
diff changeset
     8
====INSTALLATION====
459b2503c1a3 Rename some stuff, create a README file, enable warnings in ./jingle
Nicolas Cornu <nicolas.cornu@ensi-bourges.fr>
parents: 0
diff changeset
     9
To build the modules, you will need loudmouth and mcabber headers files along
459b2503c1a3 Rename some stuff, create a README file, enable warnings in ./jingle
Nicolas Cornu <nicolas.cornu@ensi-bourges.fr>
parents: 0
diff changeset
    10
with cmake. On Debian/Ubuntu, cmake is provided by the "cmake" package and the
459b2503c1a3 Rename some stuff, create a README file, enable warnings in ./jingle
Nicolas Cornu <nicolas.cornu@ensi-bourges.fr>
parents: 0
diff changeset
    11
loudmouth header files in "loudmouth-dev".
459b2503c1a3 Rename some stuff, create a README file, enable warnings in ./jingle
Nicolas Cornu <nicolas.cornu@ensi-bourges.fr>
parents: 0
diff changeset
    12
Once you have installed them, you can simply run "cmake .", then "make install"
459b2503c1a3 Rename some stuff, create a README file, enable warnings in ./jingle
Nicolas Cornu <nicolas.cornu@ensi-bourges.fr>
parents: 0
diff changeset
    13
as root. This should install the 3 modules in /usr/lib/mcabber.
459b2503c1a3 Rename some stuff, create a README file, enable warnings in ./jingle
Nicolas Cornu <nicolas.cornu@ensi-bourges.fr>
parents: 0
diff changeset
    14
To load them, type "/module load jingle", "/module load jingle-ft" and "module
459b2503c1a3 Rename some stuff, create a README file, enable warnings in ./jingle
Nicolas Cornu <nicolas.cornu@ensi-bourges.fr>
parents: 0
diff changeset
    15
load jingle-ibb". You can also load them automatically by putting those three
459b2503c1a3 Rename some stuff, create a README file, enable warnings in ./jingle
Nicolas Cornu <nicolas.cornu@ensi-bourges.fr>
parents: 0
diff changeset
    16
lines in your mcabberrc without the leading slash.
149
8c4129116d12 Add some example usage in the README file
Nicolas Cornu <nicolas.cornu@ensi-bourges.fr>
parents: 139
diff changeset
    17
8c4129116d12 Add some example usage in the README file
Nicolas Cornu <nicolas.cornu@ensi-bourges.fr>
parents: 139
diff changeset
    18
=======USAGE=======
8c4129116d12 Add some example usage in the README file
Nicolas Cornu <nicolas.cornu@ensi-bourges.fr>
parents: 139
diff changeset
    19
The Jingle File Transfer module provide a /jft command.
8c4129116d12 Add some example usage in the README file
Nicolas Cornu <nicolas.cornu@ensi-bourges.fr>
parents: 139
diff changeset
    20
This command has three modes:
8c4129116d12 Add some example usage in the README file
Nicolas Cornu <nicolas.cornu@ensi-bourges.fr>
parents: 139
diff changeset
    21
* "send" to send files. e.g:
8c4129116d12 Add some example usage in the README file
Nicolas Cornu <nicolas.cornu@ensi-bourges.fr>
parents: 139
diff changeset
    22
  /jft send /tmp/some_file_i_share
8c4129116d12 Add some example usage in the README file
Nicolas Cornu <nicolas.cornu@ensi-bourges.fr>
parents: 139
diff changeset
    23
  Note that like in a shell, ~ refer to your home dir.
8c4129116d12 Add some example usage in the README file
Nicolas Cornu <nicolas.cornu@ensi-bourges.fr>
parents: 139
diff changeset
    24
* "info" to list transfers.
8c4129116d12 Add some example usage in the README file
Nicolas Cornu <nicolas.cornu@ensi-bourges.fr>
parents: 139
diff changeset
    25
* "flush" to remove finished transfers.