This is the README file for Sharity 2, a CIFS client program for Unix.
To view the HTML user documentation point your web browser to the file
manual/01-index.html (in the binary distribution, it's at
source/doc/manual/01-index.html in the source distribution).

Here's a (very) quick guide if you don't want to read much:
  * If you have the binary distribution:
      - Unpack the archive (you must already have done that because you
	    would not be able to read the README file otherwise).
      - Start the script "./setup" and answer the questions.
	  - Try the options "-h" and "-man" for the commandline utilities.
  * If you have the source distribution:
      - Edit the file source/Makefile.config appropriate for your system.
	  - Install GTK+ 1.2, if you want a GUI (see http://www.gtk.org/).
	  - Go to the "source" directory and type "make". Building the GUI
	    will fail if you don't have GTK+. This is not fatal.
	  - Go to the "install" directory and type "./setup".


***************
IMPORTANT NOTE:
***************
Do not remove the package by deleting it with 'rm -r'. Sharity mounts
servers in its install directory automatically. If you use a recursive
delete, you may easily delete all the files on your servers! Use the
uninstall script which is installed in Sharity's install directory instead!


What is Sharity?
================
Sharity is a software package that runs on Unix machines and allows you to
mount shares exported by Windows (NT, 95, for Workgroups, etc.), OS/2,
samba etc. in your filesystem. It's NOT an ftp-like client like the
smbclient program distributed with samba, it really mounts the shares in
your filesystem just as NFS does. Since the major release 2, Sharity
supports browsing (like the Windows "Network Neighborhood") and has a GUI
for dialogs and for the configuration.

Installation
============
There are two kinds of distribution: the binary distribution and the source
distribution. If you have a binary distribution for your platform, continue
at step 4. Otherwise do the following:
1. You need gcc (the GNU C-compiler) in order to compile Sharity. Any other
   compiler might work if it supports the 'inline' keyword and the 'long long'
   data type. Hint: "-Dinline=__inline" does the trick for many compilers.
2. Go to the source directory "source" and edit Makefile.config. You may need
   to change the c-compiler and the CFLAGS variable for your platform. The
   comments in this file will guide you.
3. Type 'make' in the "source" directory. This will build the program and put
   the executables and supporting files into the "install" directory.
   You need GTK+ version 1.2 in order to compile the GUI program. If you don't
   have GTK+ installed, the build will fail. This is not fatal: You will still
   be able to use the commandline user interface.
4. As root, type './setup' in the "install" directory (or the main directory
   where the "setup" script is located, if you have the binary distribution).
   This script asks you a couple of questions before installing Sharity.
   If you have a previous version of Sharity installed, please remove it
   before the installation.
5. Start (or re-start) the sharity daemon. You can do this by typing:
      /usr/local/sharity/sbin/sharity.init stop
      /usr/local/sharity/sbin/sharity.init start
   in a terminal window (as root). You should also make a symbolic link from
   your startup directory (this may be /etc/rc?.d, /etc/startup,
   /sbin/init.d/rc?.d or whatever, depending on your operating system) to
   /usr/local/sharity/sbin/sharity.init. If your system uses an /etc/rc.local
   file instead of a startup directory, call
      /usr/local/sharity/sbin/sharity.init start
   from the rc.local script. If you did not use the default installation
   path, you must replace /usr/local/sharity with the new path in the above
   examples, of course.
6. Every new installation of Sharity must be re-registered. Type
   'cifslicense <your license key> to enter the license key.
7. If you ever want to remove Sharity from your computer, use the script
      /usr/local/sharity/uninstall.


How do I use Sharity?
=====================
Sharity is a package consisting of several programs. The central point
is the sharity daemon. This daemon should be started during system
startup and is required for every operation. Users don't interact with
the daemon directly. They may use commandline utilities such as the 'cifs*'
programs (or the more general 'sharity' wrapper), or they may use the GUI
application "Sharity". For more information, please use the option "-h" for
the commandline utilities or the online help in the GUI application.


---
Contact information:
e-mail: sharity@obdev.at
www:    http://www.obdev.at/
Author: Christian Starkjohann <cs@obdev.at>
