#
#     Copyright (C) 1997-2004 Arkeia Corporation
#

Document          : README for arkc configuration
Version           : 5.3
Author            : Arkeia Corporation
Created           : 1999/06/01
Last modification : 2004/08/09


Description:
------------

This is the README file for arkc, the Arkeia command line tool.  This
file contains general information and directions to start using
arkc. If you have suggestions contact us at the following mail
address: arkc@arkeia.com

+========================================================================+
|                                                                        |
| Table of contents:                                                     |
| ------------------                                                     |
|                                                                        |
| 1.0   Which files should be present in the arkc directory?             |
| 2.0   What should I do before using arkc for the first time?           |
|                                                                        |
+========================================================================+

                        README


1.0     Which files should be present in the arkc directory?
==========================================================================

The arkc installation adds the following files or scripts under the
system directory and Arkeia home directory ( /opt/arkeia ).

        /usr/bin/arkc
        $/opt/arkeia/bin/arkc
        $/opt/arkeia/arkc
        $/opt/arkeia/arkc/README  (Current file)
        $/opt/arkeia/arkc/FAQ
        $/opt/arkeia/arkc/arkc.prf
        $/opt/arkeia/arkc/arkc.param
        $/opt/arkeia/arkc/arkc.sample
        $/opt/arkeia/arkc/script


2.0    What should I do before using arkc for the first time?
==========================================================================

        A.      First, check that the arkc binary is correctly installed.
                To do this, enter the following command:

                # arkc

                If this command fails, you should check your PATH
                settings.

        B.      arkc requires some information to work correctly.
                You have to specify: 

		    (a) the backup server name,
		    (b) the login and 
		    (c) the password. 

		 Enter these in the file:

                $(ARKEIADIR)/arkc/arkc.param file.

                If you want to customize your arkc connection information,
                you have to create a preference file in your home
                directory.

                For more information on this, please refer to the
                -pref option in the main arkc help, by entering:

                # arkc -usage

        C.      Your arkc configuration is now complete. You can now
                enter a few commands.

		C-1. First, check the content of the file:

			    $(ARKEIADIR)/arkc/arkc.param file

		     To do this, enter the following command:

			    # arkc -debug -who

		     This command displays the backup server name,
		     server version, and login information.

                C-2. You should check that you can connect to the
		     backup server. To check this connection, enter
		     the command:

			    # arkc -tape -list

		     This command displays the existing tapes list. If
		     an error occurs while running this command, an
		     error message is printed.

        D.      How can I obtain more information about arkc?

                D-1. The first suggestion is to read carefully the
		     main arkc help. To do this, enter the command:

			   # arkc -usage

                D-2. Read the FAQ file. It contains many questions and
		     answers which could prove very helpful.

                D-3. Examine the contents of the script directory:

			   $(ARKEIADIR)/arkc/script/

		     There, you'll find a few scripts demonstrating
		     common arkc implementation.

		D-4. See Arkeia Network Backup Command Line Manual at
		     http://www.arkeia.com/a5manuals.html




