]> code.delx.au - pymsnt/blob - docs/user.html
Updated rev and url
[pymsnt] / docs / user.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4 <head>
5 <meta http-equiv="content-type" content="text/html; charset=iso-8859-1"/>
6 <link rel="stylesheet" href="style.css" type="text/css"/>
7 <title>Jabber MSN Gateway User Guide</title>
8 </head>
9
10 <body>
11
12 <h1>Jabber MSN Gateway User Guide</h1>
13
14
15 <p>Please visit the <a href="http://delx.cjb.net/pymsnt/docs/server.html">Server Administrator Guide</a> if you are a server administrator looking for information on how to configure/install the transport.</p>
16 <p>If you have any insights or comments to add to this page please contact me by Jabber or email: james&#64;delx.cjb.net</p>
17
18 <hr/>
19
20
21 <h2>Usage Guide</h2>
22
23 <p>You must already have a Jabber client (a program to connect to a Jabber server) set up with your Jabber account to follow these instructions</p>
24
25 <p>These are generic instructions, intended to be useful no matter which Jabber client or what operating system you are using. Please read through them in their entirety before beginning.</p>
26
27 <hr/>
28
29 <h3>Getting started - Registration</h3>
30 <p>
31 It is recommended that you register using the <a href="http://delx.cjb.net/pymsnt/webreg">Jabber Transport Registration Form</a>.
32 Your Jabber server may have this form available on their website. So have a look there too.
33 </p>
34 <p>
35 To register with your Jabber client, follow these steps.
36 </p>
37 <ul>
38 <li>First, you must check that your Jabber server has the MSN gateway installed. To do this, look for a menu item or button labelled something like "Browse Services", "Service Discovery" or "Transports/Gateways".</li>
39 <li>If you see "MSN Transport" in the list you can continue, otherwise you can either ask the person who runs your Jabber server to install the MSN gateway, or you can try using the transports from another server. If there is an option to browse to a different server you may want to use that to use the MSN Gateway on another server.</li>
40 <li>To proceed you must be able to choose to register with the MSN Transport from the browse list. You can usually do this by double-clicking it's icon, or clicking it and choosing register.</li>
41 <li>Type your MSN passport into the username field (eg, fred@hotmail.com) and fill in your password.</li>
42 <li>When you click the register button you will receive a Jabber authorisation message (to do with allowing users to view your online status) for each user on your MSN list. This can be a lot of messages. This step can only be avoided by using the <a href="http://delx.cjb.net/pymsnt/webreg">Transport Registration Form</a> mentioned above. Some clients (notably <a href="http://psi-im.org">Psi</a>) provide an option in the advanced section to auto-accept authorisation requests. You may wish to turn this on before continuing, and then turn it off afterwards. Please note that this flood will only occur once, upon registration of the transport.</li>
43 <li>Click the register button, and accept any subscription messages you see.</li>
44 <li>You should now be registered with the MSN transport. You should see the users from your MSN contact list appear. These steps will not need to be repeated.</li>
45 </ul>
46
47 <hr/>
48
49 <h3>Adding a friend to your list</h3>
50 <p>
51 To add a person who only uses MSN to your contact list you must translate their MSN passport (eg, bob@hotmail.com) into a Jabber ID. This is very simple to do.<br/>
52 Many clients will do this for you automatically if you tell them to:
53 </p>
54 <ul>
55 <li>In Psi, choose &quot;Add Contact&quot; from the menu.</li>
56 <li>Select MSN from the list</li>
57 <li>Type your friend's MSN ID in the box</li>
58 <li>Click the &quot;Get Jabber ID&quot; button, then click &quot;Add&quot;, and you're done.</li>
59 </ul>
60 <p>For clients that do not support this, you must manually translate their MSN passport. Here are some examples:</p>
61 <ul>
62 <li>If the MSN passport is bob@hotmail.com, and your Jabber server's MSN Transport address is msn.host.com, then the Jabber ID of that MSN user is bob%hotmail.com@msn.host.com</li>
63 <li>If the MSN passport of the user is fred@yahoo.com, and your Jabber server is tipic.com, then the Jabber ID of that user is fred%yahoo.com@msn.tipic.com</li>
64 <li>All that happens is the @ symbol is exchanged for a % sign, and you add @msn.host.com to the end.</li>
65 </ul>
66
67
68 <hr/>
69
70 <h3>Chatting with friends</h3>
71 <ul>
72 <li>To chat with a MSN user you perform the same process you would for a Jabber user, simply double-click their name in your contact list, and chat type a message.</li>
73 <li>To start a groupchat (more than one person in a &quot;room&quot;) with MSN users you must do the following.
74 <ul>
75 <li>Join a room on the msn.host.com server (where host.com is your Jabber server). The room name is not important, just make sure it does not have a % sign in it.</li>
76 <li>Invite your MSN contacts to this room to chat with them</li>
77 <li>Note that you cannot invite other Jabber users to this room. Attempts to do so will fail. This will not be possible in the future either</li>
78 </ul>
79 </li>
80 </ul>
81
82 <hr/>
83
84 <h3>Setting personal details</h3>
85 <ul>
86 <li>Out of all the data in your Jabber vCard, only the photo and your nickname can be sent to MSN users.</li>
87 <li>You can set a nickname in Psi by going to Account Setup-&gt;Modify-&gt;Details-&gt;Edit Personal Details. In recent versions this will allow you to set your avatar as well.</li>
88 <li>Your Jabber status message appears to MSN users as the &quot;Personal Message&quot;</li>
89 </ul>
90
91 <hr/>
92
93 <h3>Multiple Resources</h3>
94 <p>Jabber allows you to log into your account multiple times. For example, you could be logged in at home, at work, and on your laptop simultaneously.</p>
95 <p>Because MSN Messenger does not have any concept of this, messages will always go to your <i>highest priority</i> resource by default. It is important to set the client you're using to a higher priority that the ones that you're not.</p>
96 <p>If you do happen to send a message to somebody from a lower priority resource, then messages from that person will be sent to that resource until:</p>
97 <ul>
98 <li>You log out from that resource.</li>
99 <li>You send a message to that person from another resource.</li>
100 <li>That user closes the chat window on their machine.</li>
101 </ul>
102
103 <hr/>
104
105 <h3>Things that don't work yet</h3>
106 <ul>
107 <li>Avatars and file transfer are supported, but only in the latest release. So you may need to ask your server administrator to update. Also, you need to make sure your Jabber client supports avatars and file transfer.</li>
108 <li>Please do not add yourself to your contact list.</li>
109 </ul>
110
111 <hr/>
112
113 <h3>Misc Notes</h3>
114
115 <ul>
116 <li>If you wish to remove the MSN transport and all of your MSN contacts from your Jabber contact list you must be sure to remove the MSN transport <em>first</em>, followed by the contacts. If you do it the other way around then your MSN contacts will be removed from the MSN server's contact list too (so the next time you sign in with MSN Messenger you will have no contacts)</li>
117 <li>If your MSN transport session seems frozen, and logging in &amp; out doesn't fix it. Try double-clicking the MSN Transport icon in your list, and sending a &quot;end&quot; as a message. That should log you out of MSN and you can try using the transport again.</li>
118 </ul>
119
120 <hr/>
121 <p>Copyright James Bunton &lt;james at delx.cjb.net&gt;. You may freely redistribute this file.</p>
122
123 </body>
124
125 </html>