annotate doc/gaim-remote.1.in @ 10758:c80a609bd747

[gaim-migrate @ 12361] A few other minor changes. committer: Tailor Script <tailor@pidgin.im>
author Mark Doliner <mark@kingant.net>
date Sun, 27 Mar 2005 22:48:04 +0000
parents a47f038ecf9a
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6954
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
1 .TH gaim-remote 1
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
2
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
3 .SH "NAME"
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
4 gaim-remote v@VERSION@ \- Gaim command-line remote control
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
5
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
6 .SH "SYNOPSIS"
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
7 .TP 5
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
8 \fBgaim-remote \fI[command]\fR \fI[parameters]\fR
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
9 .TP 5
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
10 \fBgaim-remote -h \fI[command]\fR
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
11
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
12 .SH "DESCRIPTION"
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
13 .PP
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
14 \fbgaim-remote\fR is a command-line interface for controlling an already-running instance of the Gaim Instant Messaging client. It currently has only rudimentary support for launching AIM-style URIs, and closing the running instance, although further functionality is planned.
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
15
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
16 .SH "OPTIONS"
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
17 The following options are provided by \fBgaim-remote\fR:
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
18 .TP
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
19 .B \-h [\fIcommand\fB]
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
20 Display help for \fBgaim-remote\fR or a specific command (see below).
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
21
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
22 .SH "COMMANDS"
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
23 The following commands are implemented by \fBgaim-remote\fR:
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
24 .TP
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
25 .B quit
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
26 Closes the currently-running instance of \fBGaim\fR.
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
27 .TP
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
28 .B uri [URI]
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
29 Sends the given AIM-style URI to the currently running instance of \fBGaim\fR (see below).
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
30
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
31 .SH "URIs"
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
32 The following URIs are currently valid. These default to acting on the first AIM account you have in your list:
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
33 .TP
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
34 .B aim:goim?screenname=[SCREENNAME]
8656
a47f038ecf9a [gaim-migrate @ 9408]
Mark Doliner <mark@kingant.net>
parents: 6954
diff changeset
35 Begins a new conversation with the given screenname.
6954
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
36 .TP
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
37 .B aim:goim?screenname=[SCREENNAME]&message=[MESSAGE]
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
38 Sends the given message to the screenname. Spaces in the message must be replaced with +.
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
39 .TP
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
40 .B aim:gochat?roomname=[CHATROOM]
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
41 Opens a chat window in the given room.
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
42 .TP
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
43 .B aim:addbuddy?screenname=[SCREENNAME]
8656
a47f038ecf9a [gaim-migrate @ 9408]
Mark Doliner <mark@kingant.net>
parents: 6954
diff changeset
44 Opens a dialog to add the specified buddy to your buddy list.
6954
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
45
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
46 .SH "FILES"
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
47 .TP
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
48 .I /tmp/gaim_[USERNAME].[INSTANCE]
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
49 The UNIX domain socket used to contact the running instance of \fBGaim\fR.
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
50
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
51 .SH "SEE ALSO"
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
52 .BR gaim (1),
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
53 .BR \fIhttp://gaim.sourceforge.net/\fR,
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
54 .BR \fIhttp://www.sourceforge.net/projects/gaim/\fR
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
55
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
56 .SH "AUTHOR"
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
57 .PP
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
58 This manpage was written by Robert McQueen <\fIrobot101@debian.org\fR>
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
59 for the Debian GNU/Linux system (but may be used by others).
01c297526fad [gaim-migrate @ 7501]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
60