Added ATTR command to handle requested attributes for WHOIS.
[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 The following options to ATTR command are available:
32
33   allow
34     - Info:     Allow/Disallow sending of information
35     - Format:   ON/OFF, ON by default
36     - Examples:
37       ATTR allow OFF
38       ATTR allow ON
39
40   vcard
41     - Info:     Your personal information (business card)
42     - Format:   path to VCard file
43     - Examples:
44       ATTR vcard /home/foo/.silc/vcard
45
46   services
47     - Info:     List of network services you are using
48     - Format:   list of <address>:<port>
49     - Examples:
50       ATTR services silcnet.org:706
51       ATTR services silcnet.org:706 irc.org:6667
52
53   status_mood
54     - Info:     Indication of your personal mood at the present time
55                 By default, setting this is aliased to MOOD command
56     - Format:   list of moods (moods: NORMAL, HAPPY, SAD, ANGRY, JEALOUS,
57                                ASHAMED, INVINCIBLE, INLOVE, SLEEPY,
58                                BORED, EXCITED, ANXIOUS)
59     - Examples:
60       ATTR status_mood HAPPY INLOVE
61       MOOD SLEEPY BORED INVINCIBLE
62
63   status_text
64     - Info:     Text message further describing your current status
65     - Format:   text string
66     - Examples:
67       ATTR status_text "Not much going on, right now..."
68
69   status_message
70     - Info:     MIME message further describing your current status
71     - Format:   File path to file containing a MIME object
72     - Examples:
73       ATTR status_message /home/foo/.silc/message
74
75   preferred_language
76     - Info:     Language you would like to use in SILC
77     - Format:   list of three letter language codes (ISO 639-2/T)
78                 See http://www.loc.gov/standards/iso639-2/langcodes.html
79     - Examples:
80       ATTR preferred_language fin
81       ATTR preferred_language eng fin
82
83   preferred_contact
84     - Info:     Contact method you prefer
85     - Format:   List of preferred contact methods
86                 (methods: NONE, EMAIL, CALL, PAGE, SMS, MMS, CHAT)
87     - Examples:
88       ATTR preferred_contact NONE
89       ATTR preferred_contact CHAT EMAIL SMS
90
91   timezone
92     - Info:     Send your local time and timezone
93     - Format:   ON/OFF, ON by default
94     - Examples:
95       ATTR timezone OFF
96
97   geolocation
98     - Info:     Your current measured global location
99     - Format:   longitude:latitude:altitude:accuracy in meters
100     - Examples:
101       ATTR geolocation "60 10:24 57:251:20"
102
103   device_info
104     - Info:     Type of your device you are using
105     - Format:   Device type:manufacturer:version:model:language
106                 (types: COMPUTER, MOBILE_PHONE, PDA, TERMINAL)
107     - Examples:
108       ATTR device_info COMPUTER:Debian:2.4:Linux:eng
109       ATTR device_info PDA:Palm, Inc.:1.0:Zire,eng
110
111   public_keys
112     - Info:     List of your public keys you want to send in the reply,
113                 The client automatically sends your SILC public key
114     - Format:   List of file paths to public key files with key type
115                 (silc-rsa, silc-dss, ssh-rsa, ssh-dss, pgp-sign-rsa,
116                  pgp-sign-dss, x509v3-sign-rsa, x509v3-sign-dss)
117     - Examples:
118       ATTR public_keys ssh-rsa:/home/priikone/.ssh2/ssh2.pub
119       ATTR public_keys pgp-sign-rsa:/home/priikone/pgp/pgp.asc
120
121 See also: WHOIS, MOOD