source: trunk/third/jwgc/README @ 22406

Revision 22406, 3.3 KB checked in by ghudson, 19 years ago (diff)
This commit was generated by cvs2svn to compensate for changes in r22405, which included commits to RCS files with non-trunk default branches.
Line 
1+=============================================================================+
2|          _                                                                  |
3|         (_)      ______ ______              Jabber                          |
4|        / / | /| / / __ `/ ___/               WindowGram                     |
5|       / /| |/ |/ / /_/ / /__                  Client                        |
6|    __/ / |__/|__/\__, /\___/                                                |
7|   /___/         /____/           "But I -like- my ugly X Windows!" -me      |
8|                                                                             |
9+=============================================================================+
10                         http://jwgc.sourceforge.net/
11
12The Jabber Windowgram Client is based entirely off of MIT's Zephyr Windowgram
13Client program, and is designed to behave almost exactly the same. It supports,
14or will support, most or all of the same functions that zwgc and other jabber
15clients support.
16
17If you are interested in submitting patches, places note the BUILDINFO file
18for information about the environment(s) with which I develop and compile
19jwgc.
20
21
22
23
24Installation
25-------------------------------------------------------------------------------
26Compilation and installation should go fairly smoothly on most unix-based
27operating systems.  The most simple set of instructions are:
28
291. Untar the distribution
302. Change into the distribution directory
313. Run: ./configure
324. Run: make
335. Run: make install
34
35This installs into /usr/local by default, so you may need to add a --prefix
36option to specify a path you have access to install into.  You should also
37run configure with the --help option to see the available options.  The
38options should be self-explanatory.  The defaults are in parenthesis.
39
40
41
42
43Usage
44-------------------------------------------------------------------------------
45By default, jwgc will try to log you into the jabber server specified at
46configure time, with your local unix username, and will prompt you for a
47password.  You should run jwgc with -h to see how you can change these
48settings at run time.  You may also want to read over the jwgc man page.
49
50The available commands are as follows:
51jwgc - the core piece that connects you to the jabber server, and handles
52       all incoming and outgoing messages.  no other commands will work
53       without jwgc running.
54
55jwrite - this command allows you to send a message to another user.
56
57jlocate - this command allows you to check your "buddy list".
58
59jstat - this command allows you to check on the status of jwgc, and your
60        connect to the jabber server.
61
62jctl - this command contains all other functions, such as subscriptions,
63       configuration, and shutdown.
64
65All of these commands come with man pages that describe their usage.  They
66should all also accept a -h flag for help.
67
68
69
70
71Questions
72-------------------------------------------------------------------------------
73If you have any suggestions, questions, bug reports, whatever.. please feel
74free to either:
751. submit them via the trackers as http://www.sourceforge.net/projects/jwgc
762. drop me some email at jadestorm@users.sourceforge.net
773. drop me a jabber im at daniel@jabber.vorpalcloud.org
78
79I hope you enjoy it!  If you don't and can think of a way that it could be
80improved to make you enjoy it, let me know!
Note: See TracBrowser for help on using the repository browser.