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