Razor(R) Copyright 1992 - 2002 Visible Systems Corporation www.visible.com Notes ----- This file contains an overview of the Razor tool suite as well as instructions for installing Razor on the supported UNIX platforms. If you are installing the Razor tool suite on Windows NT, please refer to README.RazorNT for instructions. To run the Razor executables either as a demo or a purchased product, you will need to obtain license keys. Demo license keys may be obtained automatically via our web site at: http://www.visible.com/Products/Razor/keys.htm To obtain keys for purchased licenses, please contact us at 'razor_license@visible.com'. Please include the Razor identification string of the machine hosting the license server. This information can be obtained by invoking the command 'Razor_/bin/razor id' (refer to the section "Getting a license key" in this document). Overview -------- Installation of the Razor tool suite is a two-fold process. The first step is to load the distribution media to a directory on your system. The second step is to create the Razor database with which users will interact. Downloading executables ----------------------- Razor is available on both our web site, www.razor.visible.com, and our ftp site, ftp.razor.visible.com. Please contact the Razor sales staff ('razor_sales@visible.com') for alternate media. Installation ------------ Determine where the Razor executables will reside. Your system administrator may be of help suggesting a location that will insure access for all users of the tool suite. The next step is to execute the install script 'Razor_/scripts/rz_install'. This script will query the user regarding how the tool should be set up. The final step is to create a Razor database using the 'rz_new_database' script. Below is a sample installation for a SunOS machine, assuming that you will be installing Razor in the directory /3rdparty. Please note that you must have write privilege to the directory where you are installing Razor. cd /3rdparty If you downloaded the release from our web or ftp site, you will have the compressed tar file 'Razor_tar.Z'. Extracting the executables from the compressed tar file ------------------------------------------------------- zcat Razor.tar.Z | tar xf - You will now have a 'Razor_' directory in the /3rdparty directory (or whatever directory you may have chosen). This will create a directory structure (along with README files, RELEASE_NOTES and a VERSION file) which looks like this: /-- Chart |-- Razor_iw_lib |-- bin |-- doc |-- examples |-- glyphs Razor_ -------+-- help |-- lib |-- sample_db |-- scripts | /-- Issues_tables_templates | |-- Tables \-- templates --+-- Threads_tables_templates \-- Versions_tables_templates Directory Contains... --------- ----------------------------------------------------------- Chart Chart package used by the Report Generator Razor_iw_lib Files used by IssueWeaver bin All of the Razor tool suite executables doc A good place to put the manual after download help Online documentation glyphs Sample bitmaps which may be attached to the various displays lib For Solaris and SunOS ONLY. Contains XKeysymDB and NLS files. sample_db Customized issues and file control groups scripts Installation and database query scripts examples Sample shell scripts templates Templates used when creating Razor groups Files Description ----- ----------- README A general overview README.Documentation Information regarding manuals README.IWAdmin Overview of the IssueWeaver Admin tool README.IssueWeaver Overview of web interface add-on product README.Razor This README file README.RazorNT Overview of Razor for Windows NT README.RazorPC Overview of Razor PC client applications README.RazorSCC Overview of Razor integration with Windows IDEs README.Upgrade Instructions for upgrading Razor installation RELEASE_NOTES Overview of enhancements and corrections VERSION Razor release version and platform information Running rz_install ------------------ The script 'rz_install' is used for new installations and upgrades. The first question asked is whether this is a new installation or an upgrade. For new installations, you will be asked if you want to create a symbolic link to the Razor tools. We recommend you answer 'y' (the default). This will help make product updates go more smoothly for you later on in that users can always point to the Razor executables in the 'Razor' directory. The next question will be where to install the Razor license manager data files. A directory Razor_lm will be created in the directory you specify. Make note of this directory. It will be used when you are ready to install the license keys and to set the environment variable RAZOR_LICENSE_DIR a little later. You will then be asked if you want to use RCS as the archival engine (version control system) rather than the default, SCCS. If you aren't sure, answer 'n' to use SCCS instead of RCS. Creating the Razor Database --------------------------- The final step is to create your Razor database using the script, 'rz_new_database'. The database must be put in a place where all users will be able to read from. Again, your system administrator will be of help here. Create the directory and then run the 'rz_new_database' script. NOTE: This script MUST be run by the user who will be the owner of the database. To minimize permissions and security issues, the owner of the database should NOT be root. Sample database creation ------------------------ The example below puts the database in a fictitious directory named /home/elmo/mark, and places the installation in the directory /3rdparty/Razor_/scripts. Please substitute the directory path you have chosen. REMEMBER: This script MUST be run by the user who will own the Razor database. Refer to Chapter 2 of the manual, "Creating databases" for details. mkdir /home/elmo/mark/Razor_db cd /3rdparty/Razor_/scripts ./rz_new_database You will be asked where you want to put the Razor database. Answer with the full path to the database directory. In the example, the entry would be /home/elmo/mark/Razor_db. Again, this is a fictitious name; your response will be different. The rz_new_database script will also ask for the name of your Razor group. A Razor group should not be confused with a UNIX group, they are different "beasts". A Razor group is simply the database in which a team of people will work on related files. The rz_new_database script will scroll out alot of information (as well as put it into the file 'razor_new_database.info' in the directory where the script executed). Please take the time to read through it and follow the directions as presented. If you don't, you'll have to figure out a bunch of things on your own and could end up being totally frustrated. (We don't want that to happen if we can help it!) Configuring the tool -------------------- One of the nice things about the Razor tool suite is its flexibility to meet practically any process you may want to implement. This configurability is handled through ASCII configuration files in the database. Please refer to the Razor Manual for details. A copy of this manual can be downloaded from our web/ftp site. Getting a license key --------------------- For those users who are receiving this release as a purchased product, you will need to contact us for a license key. For those who are evaluating it, you will need to obtain a demo key. Until you do this, the tool will not execute. When running a demo license, the tools will not allow operations on files beyond version 1.5. This will allow you to get started and once a purchased key is installed, pick up right where you left off. The best way to get a key is to determine which machine will be running the license manager program. Log into that machine and use the 'razor id' command (just go to the Razor/bin directory and type in the command: ./razor id ) and send this ID via e-mail to: razor_license@visible.com. We will respond with the license key immediately. Or, you can call us at: (315) 363-8000 Once you have a license key, you will modify the Razor_lm/Licenses file in your license directory with the information supplied by us. You may also use the command "razor license" to enter the license keys. The license directory is the directory specified in the section above 'Running rz_install' Starting the license manager ---------------------------- The first step to running any of the Razor tools is to start the license manager (razor_lm). The license manager manages the available license tokens. The razor_lm must run on the licensed machine. Please contact us for your license (described above). By default, the license manager will validate remote users (PC client and UNIX remote client applications and IssueWeaver) against the Razor password file (refer to Chapter 2 of the manual, "Remote client password"). This default behavior may be changed to force the license manager to validate users against the local password file (razor_lm -p) or to validate users against both the local and Razor password files (razor_lm -P). Refer to Chapter 2, "License manager", for details. The Razor license manager requires the environment parameter RAZOR_LICENSE_DIR in order to run. Since you followed the directions above and have already created a database you can do one of the following to define the proper parameters depending on the type of shell you use. For C-shell users: source /rz_prep For Bourne & Korn shell users: . /rz_prep.sh To start the license manager: C-shell users: razor_lm & Bourne $ Korn shell users: nohup razor_lm & Wait for the razor_lm to indicate that "razor_lm ready to serve!" before proceeding. NOTE: The license manager only needs to be started one time or when the machine it is running on is rebooted. Starting the database server ---------------------------- The next step to running the Razor tools is to start the database server (rz_server). The database server can run on any client machine. The database server controls the access and update to the Razor database. To start the database server: razor up Wait for the program to indicate "rz_server ready to serve!" before proceeding. NOTE: The database server only needs to be started one time or when the machine it is running on is rebooted. Difficulties starting the rz_server ----------------------------------- Yes, this happens on occasion and can prove somewhat frustrating. Hopefully, a few tips here will avoid this frustration. If you get complaints about environment parameters not being set, go back to the section discussing the startup of the license manager and source the proper rz_prep file. Also note that the rz_server program starts up another program called kid_of_server. If the rz_server is still having trouble starting, make sure that both the rz_server and kid_of_server programs are not executing. You can find this out by using the 'ps' command: ps -auxww | grep server OR ps -elf | grep server and then killing the processes by specifying the process id in the 'kill' command. kill Starting the Razor tools ------------------------ Once the rz_server is running, you may start any one or all of the Razor tools. To start the issues (problem tracking) tool: issues & To start the versions (file version control) tool: versions & To start the threads (release management) tool: threads & Finally ------- Enjoy! And please send your suggestions/comments to: razor_support@visible.com Your inputs (good or bad) are very important to us! Visible Systems Corporation www.visible.com