annotate doc/gaim-remote.1 @ 6610:3beb00af2e1a

[gaim-migrate @ 7134] Fix some signal names in the docs. committer: Tailor Script <tailor@pidgin.im>
author Christian Hammond <chipx86@chipx86.com>
date Sun, 24 Aug 2003 07:14:40 +0000
parents 51fc8c91f38b
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6164
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
1 .TH gaim-remote 1
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
2
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
3 .SH "NAME"
6195
51fc8c91f38b [gaim-migrate @ 6681]
Luke Schierer <lschiere@pidgin.im>
parents: 6164
diff changeset
4 gaim-remote v0.66 \- Gaim command-line remote control
6164
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
5
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
6 .SH "SYNOPSIS"
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
7 .TP 5
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
8 \fBgaim-remote \fI[command]\fR \fI[parameters]\fR
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
9 .TP 5
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
10 \fBgaim-remote -h \fI[command]\fR
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
11
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
12 .SH "DESCRIPTION"
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
13 .PP
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
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.
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
15
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
16 .SH "OPTIONS"
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
17 The following options are provided by \fBgaim-remote\fR:
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
18 .TP
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
19 .B \-h [\fIcommand\fB]
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
20 Display help for \fBgaim-remote\fR or a specific command (see below).
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
21
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
22 .SH "COMMANDS"
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
23 The following commands are implemented by \fBgaim-remote\fR:
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
24 .TP
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
25 .B quit
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
26 Closes the currently-running instance of \fBGaim\fR.
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
27 .TP
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
28 .B uri [URI]
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
29 Sends the given AIM-style URI to the currently running instance of \fBGaim\fR (see below).
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
30
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
31 .SH "URIs"
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
32 The following URIs are currently valid. These default to acting on the first AIM account you have in your list:
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
33 .TP
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
34 .B aim:goim?screenname=[SCREENNAME]
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
35 Opens a new conversation window to the given screenname.
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
36 .TP
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
37 .B aim:goim?screenname=[SCREENNAME]&message=[MESSAGE]
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
38 Sends the given message to the screenname. Spaces in the message must be replaced with +.
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
39 .TP
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
40 .B aim:gochat?roomname=[CHATROOM]
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
41 Opens a chat window in the given room.
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
42 .TP
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
43 .B aim:addbuddy?screenname=[SCREENNAME]
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
44 Opens a dialog to adds the specified buddy to your buddy list.
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
45
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
46 .SH "FILES"
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
47 .TP
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
48 .I /tmp/gaim_[USERNAME].[INSTANCE]
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
49 The UNIX domain socket used to contact the running instance of \fBGaim\fR.
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
50
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
51 .SH "SEE ALSO"
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
52 .BR gaim (1),
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
53 .BR \fIhttp://gaim.sourceforge.net/\fR,
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
54 .BR \fIhttp://www.sourceforge.net/projects/gaim/\fR
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
55
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
56 .SH "AUTHOR"
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
57 .PP
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
58 This manpage was written by Robert McQueen <\fIrobot101@debian.org\fR>
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
59 for the Debian GNU/Linux system (but may be used by others).
2746cc773de7 [gaim-migrate @ 6645]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
60