File	Date	Author	Commit
doc	2010-04-05	François Chevallier	[294b45] Add COLOR configuration option.
maintainer	2010-04-05	François Chevallier	[08a799] Add maintainer release tools.
src	2010-04-05	François Chevallier	[ac775f] Fix typo.
.gitignore	2010-04-05	François Chevallier	[c209f4] Add fake changelog (indicate that it's generated).
COPYING	2010-04-03	François Chevallier	[095f3c] Initial commit.
ChangeLog	2010-04-05	François Chevallier	[c209f4] Add fake changelog (indicate that it's generated).
Makefile.in	2010-04-05	François Chevallier	[7ccb59] Add build tools.
README	2010-04-05	François Chevallier	[415999] Write README file.
TODO	2010-04-05	François Chevallier	[9f9d51] Update TODO file and add free distribution note.
configure	2010-04-05	François Chevallier	[7ccb59] Add build tools.
get-version	2010-04-05	François Chevallier	[809332] fix order for getting the right version.

Read Me

tokman README file
==================

Introduction
------------

tokman is an interactive command which can manage projects directory
archives on a removable media by writing a tokenring file for each project.
A tokenring file contains the computer on which the project archive was
extracted last.

It's main purpose is to share a project between computers, for example a
workstation and a laptop, without requiring a network connection while
preventing modifications on a project simultaneous on more than one computer.
The tokenring file is here to achieve this goal tokman will warn the user
if the project archive has already be extracted on another computer and not
archived back to the removable media. In this case the user will be prompted
for extracting only or forcing the record of the current computer in the
tokenring file.

See the tokman manual for more information.

Portability
-----------

tokman has been written in bash on Ubuntu but should work for other
Linux distribution as well.

Installation
------------

Out of source build directory is used.

To do a system build and installation :
    mkdir ../tokman-build
    cd ../tokman-build
    ../tokman-*.*/configure --prefix=/usr
    make

Then in superuser :
    sudo make install

But instead if you want to install tokman in your home directory :
    mkdir ../tokman-build
    cd ../tokman-build
    ../tokman-*.*/configure --prefix=$HOME/usr
    make
    make install

Stagged installation is supported :
    make DESTDIR=stage install

No uninstall target is currently provided. Instead you can do a stagged
install in a directory and use your preferred package manager to do a
package.

Doing 'make clean' will simply remove tokman from the build directory.

The configure script support the following options for paths specification :
    --prefix, --exec-prefix, --bindir, --datarootdir, --mandir

For more information on installation directories see http://www.gnu.org/prep/standards/html_node/Directory-Variables.html#Directory-Variables

Documentation
-------------

The main documentation file for tokman is given as a text file in
doc/tokman.txt formated in asciidoc format. It can be converted in DocBook
and then in various format with the command a2x provided you have installed
the asciidoc commands.

In distribution tarballs, the manpage format is provided so that even if you
don't have asciidoc, you can build and install tokman with its documentation.

If you want to regenerate the manpage if you have asciidoc commands installed
you can use the maintainer Makefile, in the project root directory, type :
    make -f Makefile man

Note that the source file tokman.txt is pretty human readable so you can
consult it directly if you want to.

Packaging
---------

The maintainer subdirectory contains scripts or makefiles for maintainers for
doing new tarball distribution releases.

maintainer/gitlog-to-changelog script comes from gnulib and is under the GPLv3.

Authors
-------

François Chevallier <calendros-tokman@dontwantspamplease.laposte.net.invalid>

This software is under the terms of the GNU General Public Licence licence,
see the COPYING file for more information.

See also
--------

For new release versions or development sources access, bug reporting,
getting help, see SourceForge website :

http://sourceforge.net/projects/tokman

Copying
-------
Copyright (C) 2010 François Chevallier

Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.  This file is offered as-is,
without any warranty.