Added SILC Thread Queue API
[crypto.git] / apps / irssi / docs / help / in / file.in
1
2 @SYNTAX:file@
3
4 This command is used to tranfer files between clients.
5 The actual file transfer stream is sent outside SILC network
6 peer to peer between the clients.  Before the file transfer
7 begins the SILC Key Exchange protocol is performed between
8 the two clients to exchange key material.  This key material
9 is then used to secure the file transfer stream between the
10 clients.
11
12 The currently active file transfer sessions can be seen by
13 giving the FILE command without arguments.
14
15 Commands:
16
17     SEND     <filepath> <nickname> [<local IP> [<local port>]]
18                                    [-no-listener]
19
20       Sends file transfer request to <nickname>.  This
21       makes the <filepath> available to <nickname>.
22
23       If the <local IP> is provided then the key exchange
24       protocol listener will be bound to that address.  If
25       <local port> is defined it is bound to that port.
26       If they are not defined then the local IP address
27       of your machine is used to bind the listener.
28
29       If the -no-listener option is used the client does not
30       bind locally but assumes that the <nickname> will provide
31       the point of connect.  This is usefull when the sender
32       is behind NAT device.
33
34       If the <local IP> and <local port> are ommitted and the
35       -no-listener option is not given, the boolean variable
36       use_auto_addr will be examined.  If it is set the value
37       of auto_bind_ip will be used as the IP address to bound
38       the listener, the value of auto_public_ip will be the IP
39       address sent to the remote client, and the auto_bind_port
40       will be the port value to be bound to and sent to the remote
41       client.  If auto_public_ip is unset, but auto_bind_ip is
42       set, SILC client will send the auto_bind_ip variable's
43       value to the remote client.
44
45     ACCEPT  [<nickname>]
46
47       Accepts the file transfer request and starts the file
48       transfer session.  If the <nickname> is omitted the
49       last received request is used.
50
51     CLOSE    [<nickname>]
52
53       Closes the file transfer session, or rejects
54       file transfer request.  If this command is given
55       during the file transfer process it will be cancelled.