'\" t
.\"     Title: MSN
.\"    Author: Julia Palandri <julia.palandri@gmail.com>
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: 12/18/2011
.\"    Manual: msn User Manual
.\"    Source: msn
.\"  Language: English
.\"
.TH "MSN" "2" "12/18/2011" "msn" "msn User Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
msn \- An opensource Python implementation for the MSN messenger protocol version 8
.SH "SYNOPSIS"
.HP \w'\fBmsn\fR\ 'u
\fBmsn\fR [\fB\fIprofilename\fR\fR]
.SH "DESCRIPTION"
.PP
This manual page documents briefly the
\fBmsn\fR
command\&.
.PP
This manual page was written for the Debian distribution because the original program does not have a manual page\&.
.PP
\fBmsn\fR
is a program intended to be used as a proof of concept for the msnlib functions\&. It shows some of the capabilities of the library\&.
.PP
When a profilename is passed as parameter, msn will use that profile account information (previously configured and stored by
\fBmsnsetup\fR) to connect\&.
.SH "COMMANDS"
.PP
The program has a builtin command "help" which shows the latest list of commands available for the program\&. Below is the complete list of commands available\&.
.PP
In most cases, when you are asked for a nick, you can alternatively enter the email\&. This makes it easier to handle people with weird or long nicks\&.
.PP
\fBstatus [\fR\fB\fImode\fR\fR\fB] \fR
.RS 4
Shows the current status, or changes it to "mode", which can be one of: online, away, busy, brb, phone, lunch, invisible, idle
.RE
.PP
\fBq \fR
.RS 4
Quits the program\&.
.RE
.PP
\fBw \fR
.RS 4
Prints your entire contact list\&. Contacts connected are highlighted in bold\&.
.RE
.PP
\fBww\fR
.RS 4
Prints your entire contact list, including email addresses\&.
.RE
.PP
\fBwn\fR
.RS 4
Prints your entire contact list, including real nicknames\&.
.RE
.PP
\fBwr\fR
.RS 4
Prints your reverse contact list (this is simply the list of all the people who have you on their contact list)\&.
.RE
.PP
\fBwd\fR
.RS 4
Prints the differences between your forward and reverse lists\&.
.RE
.PP
\fBe\fR
.RS 4
Prints your online contacts\&.
.RE
.PP
\fBee\fR
.RS 4
Prints your online contacts, including email addresses\&.
.RE
.PP
\fBeg\fR
.RS 4
Prints your online contacts with the groups\&.
.RE
.PP
\fBen\fR
.RS 4
Prints your online contacts, including real nicknames\&.
.RE
.PP
\fBh\fR
.RS 4
Shows your incoming message history\&. This is a list of the last N messages that you received\&. The amount is configurable with the directive "input history size" in the msnrc file, which defaults to 10\&.
.RE
.PP
\fBadd \fR\fB\fIemail\fR\fR\fB [\fR\fB\fInick\fR\fR\fB][\fR\fB\fIgroupname\fR\fR\fB]\fR
.RS 4
Adds the user "email" with the nickname "nick" to the group "groupname"\&.
.RE
.PP
\fBdel \fR\fB\fInick\fR\fR
.RS 4
Deletes the user with nick "nick"\&.
.RE
.PP
\fBren \fR\fB\fInick\fR\fR\fB \fR\fB\fInewnick \fR\fR
.RS 4
Renames the user with nick "nick" to appear as "newnick"\&.
.RE
.PP
\fBinfo [\fR\fB\fInick\fR\fR\fB]\fR
.RS 4
Without parameters shows your personal info\&. If a nick is passed as parameter, shows the user information and pending messages (if any)\&. It also includes some advanced information (like the server socket or tid)\&.
.RE
.PP
\fBlignore [\fR\fB\fInick\fR\fR\fB]\fR
.RS 4
Locally ignores the user, or displays the locally ignored users list\&. This makes the messages coming from the user not to be displayed, but they are still logged so you can see them later\&.
.RE
.PP
\fBlunignore \fR\fB\fInick\fR\fR
.RS 4
Removes a user from the locally ignored users list\&.
.RE
.PP
\fBblock \fR\fB\fInick\fR\fR
.RS 4
Blocks a user\&.
.RE
.PP
\fBunblock \fR\fB\fInick\fR\fR
.RS 4
Unblocks a blocked user\&.
.RE
.PP
\fBg\fR
.RS 4
Shows the groups list\&.
.RE
.PP
\fBgadd \fR\fB\fIgname\fR\fR
.RS 4
Adds the group "gname"\&.
.RE
.PP
\fBgdel \fR\fB\fIgname\fR\fR
.RS 4
Deletes the group "gname"\&. Note that all the users in the group will be deleted too\&.
.RE
.PP
\fBgren \fR\fB\fIold\fR\fR\fB \fR\fB\fInew\fR\fR
.RS 4
Renames the group "old" with the name "new"\&.
.RE
.PP
\fBcolor [\fR\fB\fItheme\fR\fR\fB]\fR
.RS 4
Shows the available color themes, or sets the color theme to "theme"\&.
.RE
.PP
\fBclose \fR\fB\fInick\fR\fR
.RS 4
Closes the switchboard connection with "nick"\&. There is no need to use this command and is included just for advanced users and debugging\&.
.RE
.PP
\fBconfig\fR
.RS 4
Shows the configuration, in the internal representation, along with other special automatic variables\&. This means that many commands and values won\*(Aqt have the same format; for instance, instead of \*(Aqyes\*(Aq you will often see a "1"\&. This command is mostly exclusively included for bug reporting\&.
.RE
.PP
\fBinfo [\fR\fB\fInick\fR\fR\fB]\fR
.RS 4
Shows the user information and pending messages (if any), or your personal info\&.
.RE
.PP
\fBnick [\fR\fB\fInewnick\fR\fR\fB]\fR
.RS 4
Changes your nick to "newnick", or shows your current nick\&.
.RE
.PP
\fBprivacy \fR\fB\fIp\fR\fR\fB \fR\fB\fIa\fR\fR
.RS 4
Sets whether to accept messages from people who is not on your list (p) and require authorization (a)\&.
.RE
.PP
\fBm \fR\fB\fInick\fR\fR\fB \fR\fB\fItext\fR\fR
.RS 4
Sends a message to "nick" with the "text"\&. The standard and most practical way of sending a message\&. Tab completion expands to this\&.
.RE
.PP
\fBa \fR\fB\fItext\fR\fR
.RS 4
Sends a message with "text" to the last person you sent a message to\&.
.RE
.PP
\fBr \fR\fB\fItext\fR\fR
.RS 4
Sends a message with "text" to the last person that sent you a message\&.
.RE
.PP
\fBinvite \fR\fB\fInick1\fR\fR\fB to \fR\fB\fInick2\fR\fR
.RS 4
Invites nick1 into the chat with nick2\&.
.RE
.SH "FILES"
.PP
${HOME}/\&.msn/msnrc
.RS 4
The default configuration file for the account information, stored by
msnsetup\&.
.RE
.PP
${HOME}/\&.msn/msnrc\-{profilename}
.RS 4
The configuration file for a specific profile name that stores that account information, chosen by the user and stored by
msnsetup\&.
.RE
.SH "DIAGNOSTICS"
.PP
The following diagnostics may be issued on
stderr:
.PP
Bad configuration file\&. Exiting\&.
.RS 4
The configuration file seems to contain a broken configuration line\&. Use the
\fB\-\-verbose\fR
option, to get more info\&.
.RE
.PP
\fBmsn\fR
provides some return codes, that can be used in scripts:
.\" line length increase to cope w/ tbl weirdness
.ll +(\n(LLu * 62u / 100u)
.TS
ll.
\fICode\fR	\fIDiagnostic\fR
T{
\fB0\fR
T}	T{
Program exited successfully\&.
T}
T{
\fB1\fR
T}	T{
The configuration file seems to be broken\&.
T}
.TE
.\" line length decrease back to previous value
.ll -(\n(LLu * 62u / 100u)
.sp
.SH "BUGS"
.PP
Comments and patches are always welcome; please send them to albertito@blitiri\&.com\&.ar
.PP
Further information on how to report a bug can be found inside the documentation directory, in the file \*(Aqreporting_bugs\*(Aq\&.
.SH "SEE ALSO"
.PP
\fBmsnsetup\fR(2)
.SH "AUTHOR"
.PP
\fBJulia Palandri\fR <\&julia\&.palandri@gmail\&.com\&>
.RS 4
Wrote this manpage for the Debian system\&.
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2011 Julia Palandri
.br
.PP
This manual page was written for the Debian system (and may be used by others)\&.
.PP
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 or (at your option) any later version published by the Free Software Foundation\&.
.PP
On Debian systems, the complete text of the GNU General Public License can be found in
/usr/share/common\-licenses/GPL\&.
.sp