Merge from vendor branch OPENSSH:
[dragonfly.git] / contrib / smbfs / INSTALL
1     1. Building
2     ===========
3
4     Copy config.in file to the config.local and edit it for your needs. Build
5 process requires kernel sources in order to compile KLD module. If you want
6 to use encrypted passwords you'll need an src/sys/crypto directory (sys-crypto
7 cvsup collection) because encryption process involves DES algorithm.
8
9     Note for FreeBSD-current: it have kernel module sources in the base
10 tree and requires options LIBMCHAIN and LIBICONV included in the kernel
11 config file. smbfs can be either compiled in the kernel or loaded as module.
12
13     If FreeBSD machine and SMB server uses different character sets you
14 may consider install ports/converters/iconv package (version 2.0 required).
15
16     Type 'make' to compile.
17         
18     If you're running any previous version of smbfs, unmount all mounted
19 shares and unload an old module via 'kldunload smbfs' command.
20
21
22     2. Installing
23     =============
24
25     'make install' command will copy compiled binaries to /usr/local/bin
26 directory and KLD module into /modules directory.
27
28     If you're running smbfs for the first time, it is also necessary to
29 run 'make makedev' command in order to create /dev/nsmb0 device.
30
31     3. Configuring
32     ==============
33
34     KLD module can be loaded either manually:
35     
36     kldload smbfs.ko
37
38  or via loader.conf(5) file:
39
40     smbfs_load="YES"
41
42     However it is not strictly necessary because mount_smbfs(8) command
43 will load it automatically.
44
45     Copy ./examples/dot.nsmbrc file into your home directory with ./.nsmbrc
46 name and edit it for your needs.
47
48
49     4. Running
50     ==========
51
52     Please read mount_smbfs man page to get overview of command options.
53
54     Here is a quick example:
55
56         mount_smbfs -I hostname //bp@myserver/myshare /mnt
57
58     If something goes wrong, please try to find a problem and, if it is a bug
59  send me detailed description or patch. Before complaining about a bug, please
60  check the same operations with smbclient program included in the Samba package.
61  
62
63
64     5. Deinstalling
65     ===============
66
67     All files can be completly removed by typing 'make deinstall' in the 
68 working directory.