Merged silc_1_0_branch to trunk.
[silc.git] / doc / silcd.yo
1 manpage(SILCD) (8) (November 20 2003) (silc-server) (silc-server)
2
3
4 manpagename(silcd) (SILC server)
5
6
7 manpagesynopsis()
8 bf(silcd) bf([) -f em(file) | -d | -D | -x | -h | -F | -C em(path) | -V bf(])
9
10
11 manpagedescription()
12 Silcd is a server for SILC, Secure Internet Live Conferencing network.
13
14
15 manpageoptions()
16 bf(-f) em(FILE)   Read configuration from em(FILE)
17
18 bf(-d)        Enable debugging (Implies -F)
19
20 bf(-D) em(LEVEL)  Enable debug messages of level em(LEVEL) and lower (Implies -F)
21
22 bf(-x)        Enable hexdumps (Implies -d)
23
24 bf(-F)        Don't fork.  Run silcd on foreground.
25
26 bf(-h)        Display help message
27
28 bf(-V)        Display version
29
30 bf(-C) em(PATH)   Create new public key pair. See bf(KEY GENERATION) for options.
31
32 manpagesection(LONG OPTIONS)
33 bf(--config-file)=em(FILE)      Same as bf(-f)
34
35 bf(--debug)=em(STRING)          Same as bf(-d), limit to messages *em(STRING)*
36
37 bf(--debug-level)=em(LEVEL)     Same as bf(-D)
38
39 bf(--hexdump)               Same as bf(-x)
40
41 bf(--foreground)            Same as bf(-F)
42
43 bf(--version)               Same as bf(-V)
44
45 bf(--create-key-pair)=em(PATH)  Same as bf(-C)
46
47
48 manpagesection(KEY GENERATION)
49 bf(-C) must be followed directly with a path to directory into which the
50 private and public keys will be written to. When generating new key pair 
51 for silcd (bf(-C)), the following extra switches apply:
52
53 bf(--pkcs)=em(PKCS)       Set the public key algorithm of public key pair.  For example bf(rsa).
54
55 bf(--bits)=em(VALUE)      Set the length of public key pair, in bits.
56
57 bf(--identifier)=em(ID)   Set em(ID) as public key identifier.
58
59 The identifier has the format of:
60
61 UN=<username>, HN=<hostname or IP>, RN=<real name>, E=<email>,
62 O=<organization>, C=<country>
63
64 Both UN and HN are mandatory, all the rest are optional but recommended.
65 If no bf(--identifier) is used, an identifier will be created automatically.
66
67 Example:
68
69 bf(silcd -C /etc/silcd --identifier)="UN=foobar, HN=foo.bar.com, 
70 RN=Foo T. Bar, E=foo@bar.com, C=FI"
71
72
73 manpagefiles()
74 There are two configuration files for silcd: 
75 em(/etc/silc/silcd.conf) for server configuration and
76 em(/etc/silc/silcalgs.conf) for SIM (SILC Modules) configuration. 
77 Do note that silcalgs.conf is only needed if cryptographic algorithms are 
78 built as separate modules.
79
80
81 manpageseealso()
82 bf(silc(1)), bf(silcd.conf(5))
83
84
85 manpagesection(NETWORK RESOURCES)
86 Homepage: bf(http://silcnet.org)
87
88 manpageauthor()
89 SILC is designed and written by Pekka Riikonen <priikone@iki.fi> and rest
90 of the SILC Project.
91
92 This manpage was written by Mika 'Bostik' Boström <bostik@lut.fi>
93
94 See bf(CREDITS) for full list of contributors.
95