Added SILC Thread Queue API
[crypto.git] / apps / irssi / docs / help / in / attr.in
1
2 @SYNTAX:attr@
3
4 In SILC it is possible to retrieve detailed information about a user
5 with WHOIS command by giving -details option to the WHOIS.  This
6 information is retrieved directly from the client, if the client
7 supports it.  This process is called as handling a Requested Attributes 
8 in WHOIS.  If client does not support attributes or do not want to send
9 anything then server may reply on behalf of the client.
10
11 You may set your personal information that others may retrieve using
12 WHOIS command.  These information is set with ATTR command. By default, 
13 in SILC Client sending the information is allowed.  If you do not want to 
14 allow it give command:
15
16     ATTR allow OFF
17
18 and your client will not reply to the requests.  This usually means that
19 server may not send you the request anymore at all, or may do so only
20 occasionally.
21
22 Adding new information is done with ATTR command as follows:
23
24     ATTR <option> { <value>}
25
26 If the <option> already has a value the new value will replace the old
27 value.  Deleting all added information for a option is done as follows:
28
29     ATTR -del <option>
30
31 You can see your current attributing by giving the ATTR without any 
32 arguments.
33
34 The following options to ATTR command are available:
35
36   allow
37     - Info:     Allow/Disallow sending of information
38     - Format:   ON/OFF, ON by default
39     - Examples:
40       ATTR allow OFF
41       ATTR allow ON
42
43   vcard
44     - Info:     Your personal information (business card)
45     - Format:   path to VCard file
46     - Examples:
47       ATTR vcard /home/foo/.silc/vcard
48
49   services
50     - Info:     List of network services you are using
51     - Format:   list of <address>:<port>
52     - Examples:
53       ATTR services silcnet.org:706
54       ATTR services silcnet.org:706 irc.org:6667
55
56   status_mood
57     - Info:     Indication of your personal mood at the present time
58                 By default, setting this is aliased to MOOD command
59     - Format:   list of moods (moods: NORMAL, HAPPY, SAD, ANGRY,
60                                JEALOUS, ASHAMED, INVINCIBLE, INLOVE, 
61                                SLEEPY, BORED, EXCITED, ANXIOUS)
62     - Examples:
63       ATTR status_mood HAPPY INLOVE
64       MOOD SLEEPY BORED INVINCIBLE
65
66   status_text
67     - Info:     Text message further describing your current status
68     - Format:   text string
69     - Examples:
70       ATTR status_text "Not much going on, right now..."
71
72   status_message
73     - Info:     MIME message further describing your current status
74     - Format:   File path to file containing a MIME object
75     - Examples:
76       ATTR status_message /home/foo/.silc/message
77
78   preferred_language
79     - Info:     Language you would like to use in SILC
80     - Format:   list of three letter language codes (ISO 639-2/T)
81                 See http://www.loc.gov/standards/iso639-2/langcodes.html
82     - Examples:
83       ATTR preferred_language fin
84       ATTR preferred_language eng fin
85
86   preferred_contact
87     - Info:     Contact method you prefer
88     - Format:   List of preferred contact methods
89                 (methods: NONE, EMAIL, CALL, PAGE, SMS, MMS, CHAT)
90     - Examples:
91       ATTR preferred_contact NONE
92       ATTR preferred_contact CHAT EMAIL SMS
93
94   timezone
95     - Info:     Send your local time and timezone
96     - Format:   ON/OFF, ON by default
97     - Examples:
98       ATTR timezone OFF
99
100   geolocation
101     - Info:     Your current measured global location
102     - Format:   longitude:latitude:altitude:accuracy in meters
103     - Examples:
104       ATTR geolocation "60 10N:24 57W:251:20"
105
106   device_info
107     - Info:     Type of your device you are using
108     - Format:   Device type:manufacturer:version:model:language
109                 (types: COMPUTER, MOBILE_PHONE, PDA, TERMINAL)
110     - Examples:
111       ATTR device_info COMPUTER:Debian:2.4:Linux:eng
112       ATTR device_info PDA:Palm, Inc.:1.0:Zire:eng
113
114   public_keys
115     - Info:     List of your public keys you want to send in the reply,
116                 The client automatically sends your SILC public key
117     - Format:   List of file paths to public key files with key type
118                 (silc-rsa, silc-dss, ssh-rsa, ssh-dss, pgp-sign-rsa,
119                  pgp-sign-dss, x509v3-sign-rsa, x509v3-sign-dss)
120                 NOTE: CURRENTLY SILC CLIENT SUPPORT ONLY "silc-rsa"
121                 PUBLIC KEY TYPE!
122     - Examples:
123       ATTR public_keys ssh-rsa:/home/priikone/.ssh2/ssh2.pub
124       ATTR public_keys pgp-sign-rsa:/home/priikone/pgp/pgp.asc
125
126 See also: WHOIS, MOOD