view doc/gaim-remote.1.in @ 9417:9f6a28af7164

[gaim-migrate @ 10232] " IDLETRACK.DLL uses Windows hooks to record the last time the user pressed a key or moved the mouse. Windows hooks are a bit unfriendly in that they force the hook DLL into every process - so IDLETRACK.DLL gets added to every process after Gaim runs. This can mean that IDLETRACK.DLL doesn't get unloaded when Gaim stops, which causes a warning about being unable to write to IDLETRACK.DLL if you then upgrade Gaim. Further, hooking is a common tactic employed by key loggers. If the user has a program installed that checks for global hooks then it will warn the user that Gaim may contain a key logger. From Windows 2000 onwards Microsoft introduced an API function called GetLastInputInfo that returns the timer tick at the point that the user last pressed a key or moved the mouse. I have changed idletrack.c so that it will try to use this if it can, which avoids all the ugliness of having to use hooks, but it will fall back to using hooks if the function isn't present. This patch changes all three exported functions in idletrack.c. In wgaim_set_idlehooks it checks to see if GetLastInputInfo is present. If it is then the address of the function is recorded and no hooks are set. If it isn't then we're running on an old verison of Windows and the hooks are set as per current behaviour. In wgaim_remove_idlehooks the module handle taken for USER32.DLL by wgaim_set_idlehooks is released. In wgaim_get_lastactive the GetLastInputInfo function is called, if present. If it isn't present then the hooks will have run and the shared memory they write to will be read as per current behaviour. Both methods end up getting the timer tick of the last user activity, which is returned as per current behaviour." --Andrew Whewell committer: Tailor Script <[e-mail]>

.TH gaim-remote 1

.SH "NAME"
gaim-remote v@VERSION@ \- Gaim command-line remote control

.SH "SYNOPSIS"
.TP 5
\fBgaim-remote \fI[command]\fR \fI[parameters]\fR
.TP 5
\fBgaim-remote -h \fI[command]\fR

.SH "DESCRIPTION"
.PP
\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.

.SH "OPTIONS"
The following options are provided by \fBgaim-remote\fR:
.TP
.B \-h [\fIcommand\fB]
Display help for \fBgaim-remote\fR or a specific command (see below).

.SH "COMMANDS"
The following commands are implemented by \fBgaim-remote\fR:
.TP
.B quit
Closes the currently-running instance of \fBGaim\fR.
.TP
.B uri [URI]
Sends the given AIM-style URI to the currently running instance of \fBGaim\fR (see below).

.SH "URIs"
The following URIs are currently valid. These default to acting on the first AIM account you have in your list:
.TP
.B aim:goim?screenname=[SCREENNAME]
Begins a new conversation with the given screenname.
.TP
.B aim:goim?screenname=[SCREENNAME]&message=[MESSAGE]
Sends the given message to the screenname. Spaces in the message must be replaced with +.
.TP
.B aim:gochat?roomname=[CHATROOM]
Opens a chat window in the given room.
.TP
.B aim:addbuddy?screenname=[SCREENNAME]
Opens a dialog to add the specified buddy to your buddy list.

.SH "FILES"
.TP
.I /tmp/gaim_[USERNAME].[INSTANCE]
The UNIX domain socket used to contact the running instance of \fBGaim\fR.

.SH "SEE ALSO"
.BR gaim (1),
.BR \fIhttp://gaim.sourceforge.net/\fR,
.BR \fIhttp://www.sourceforge.net/projects/gaim/\fR

.SH "AUTHOR"
.PP
This manpage was written by Robert McQueen <\[e-mail]\fR>
for the Debian GNU/Linux system (but may be used by others).