home *** CD-ROM | disk | FTP | other *** search
/ C!T ROM 2 / ctrom_ii_b.zip / ctrom_ii_b / PROGRAM / C / AVTS / AVTS.DOC next >
Text File  |  1993-01-12  |  43KB  |  1,510 lines
  1.     
  2.     
  3.     
  4.     
  5.     
  6.     
  7.     
  8.     
  9.     
  10.     
  11.     
  12.     
  13.     
  14.                    ***********************************************
  15.                    *                                             *
  16.                    *   ARIS Version Tracking System Version 1.0  *
  17.                    *                                             *
  18.                    ***********************************************
  19.     
  20.     
  21.     
  22.     
  23.     
  24.     
  25.     
  26.     
  27.     
  28.     
  29.     
  30.     
  31.     
  32.     
  33.     
  34.     
  35.     
  36.     
  37.     
  38.     
  39.     
  40.     
  41.     
  42.     
  43.     
  44.     
  45.     
  46.     
  47.     
  48.     
  49.     
  50.     
  51.     
  52.     
  53.     
  54.     
  55.     
  56.             (c) 1993 Alexander Riedel Informations-Systeme
  57.                   Am Schmiedberg 16a, D-8019 Glonn GERMANY
  58.                            CIS-ID: 100042,1707
  59.                              Phone : +49-8093-5245
  60.                            Fax   : +49-8093-4975
  61.  
  62.     ARIS VERSION TRACKING SYSTEM                                        Version 1.0
  63.     -------------------------------------------------------------------------------
  64.     
  65.     Definition of Shareware. . .
  66.     
  67.          Shareware distribution gives users a chance to try software before
  68.     buying it. If you try a shareware program and continue using it, you are
  69.     expected to register. Individual programs differ on details -- some
  70.     request registration while others require it, some specify a maximum
  71.     trial period. With registration, you get anything from the simple right
  72.     to continue using the software to an updated program with printed manual.
  73.     
  74.          Copyright laws apply to both shareware and commercial software, and
  75.     the copyright holder retains all rights, with a few specific exceptions
  76.     as stated below. Shareware authors are accomplished programmers, just
  77.     like commercial authors, and the programs are of comparable quality. (In
  78.     both cases, there are good programs and bad ones!) The main difference is
  79.     in the method of distribution. The author specifically grants the right
  80.     to copy and distribute the software, either to all and sundry or to a
  81.     specific group. For example, some authors require written
  82.     permission before a commercial disk vendor may copy their shareware.
  83.     
  84.          Shareware is a distribution method, not a type of software. You
  85.     should find software that suits your needs and pocketbook, whether it's
  86.     commercial or shareware. The shareware system makes fitting your needs
  87.     easier, because you can try before you buy. And because the overhead is
  88.     low, prices are low also. Shareware has the ultimate money-back guarantee
  89.     -- if you don't use the product, you don't pay for it.
  90.     
  91.          ARIS Version Tracking System Disclaimer - Agreement. . .
  92.     
  93.          Users of ARIS Version Tracking System (AVTS) must accept this 
  94.     disclaimer of warranty: AVTS is supplied as-is.  The author disclaims 
  95.     all warranties, expressed or implied, including, without limitation, 
  96.     the warranties of merchantability and of fitness for any purpose. 
  97.     The author assumes no liability for damages, direct or consequential, 
  98.     which may result from the use of AVTS.
  99.     
  100.     
  101.     (c) 1993 Alexander Riedel Informations-Systeme,    All rights reserved
  102.     
  103.     
  104.     
  105.     
  106.     
  107.     
  108.     
  109.     
  110.     
  111.     
  112.     
  113.     
  114.     
  115.     
  116.     
  117.     
  118.     
  119.     
  120.     
  121.     
  122.     -------------------------------------------------------------------------------
  123.                                           - 2 -
  124.  
  125.     ARIS VERSION TRACKING SYSTEM                                        Version 1.0
  126.     -------------------------------------------------------------------------------
  127.     
  128.     I.   Introduction                         4
  129.     1.   What is a Version Tracking System?                 4
  130.     2.   Installing ARIS Version Tracking System             5
  131.     
  132.     II.  Tutorial                             6
  133.     1.   Creating and editing a project                  6
  134.     2.   Configuration management                     8
  135.     3.   Module history and editing activity             9
  136.     
  137.     III. Reference                            10
  138.     1.   CDC - Change Delta Comment                    10
  139.     2.   CREATE - Creates projects and apply files to them.        11
  140.     3.   DELTA - Creates a new version (delta) of a file 
  141.          in an AVTS project.                    12
  142.     4.   DIFF - Compares two files and creates a 
  143.          difference listing                        13
  144.     5.   GET - Copies a project file and locks it            14
  145.     6.   HISTORY - Prints the revision history of a file 
  146.          in an AVTS project                        15
  147.     7.   LOGVIEW - View the contents of a project's log file    16
  148.     8.   READ - Copies a project file without locking          17
  149.     9.   RMALIAS - Removes an alias name from a 
  150.          specific version of a module                18
  151.     10.  SACT - Reports current editing activity in an 
  152.          AVTS project                        19
  153.     11.  SETALIAS - Sets the alias name for one or more modules    20
  154.     12.  UNGET - Reverses a GET command without 
  155.          creating a new version                    21
  156.     
  157.     IV. APPENDIX A - ERROR MESSAGES                    22
  158.     
  159.     
  160.     
  161.     
  162.     
  163.     
  164.     
  165.     
  166.     
  167.     
  168.     
  169.     
  170.     
  171.     
  172.     
  173.     
  174.     
  175.     
  176.     
  177.     
  178.     
  179.     
  180.     
  181.     
  182.     
  183.     
  184.     
  185.     -------------------------------------------------------------------------------
  186.                                           - 3 -
  187.  
  188.     ARIS VERSION TRACKING SYSTEM                                        Version 1.0
  189.     -------------------------------------------------------------------------------
  190.     
  191.     I.    Introduction
  192.     
  193.     1.    What is a Version Tracking System?
  194.     
  195.     A Version Tracking System is a valuable tool for managing software projects 
  196.     in network environments. It prevents conflicts between team members that 
  197.     could otherwise work on the same module and keeps track of all changes that 
  198.     have been applied to a module of the software project. 
  199.     
  200.     It also helps you maintain your current configuration by preventing you from 
  201.     accidentally linking wrong modules and therefore increases the quality of your
  202.     software if you are a single programmer or if you work in a team without 
  203.     network.
  204.     
  205.     This is done by controlling access to the source files in such a way that only 
  206.     one user at a time has control over the current version of a module. All other
  207.     users are still able to read the current or earlier versions of a module for
  208.     reference or for building test applications.
  209.     Another advantage of a Version Tracking System is the ability to trace back 
  210.     the development path. You may retrieve information about who applied what 
  211.     change and when and you may even retrieve earlier versions of your modules.
  212.     This gives you the security and quality you deserve. No need to guess which 
  213.     files belong to a specific version of your software just ask for them, even 
  214.     if it is a long time ago and even if you are two, three or more version after
  215.     the one you want to have rebuilt.
  216.     
  217.     The ARIS Version Tracking System (AVTS) manages all files that belong to a 
  218.     certain project by storing these files in an internal form in a subdirectory.
  219.     This subdirectory is created under the directory where the executable files 
  220.     for AVTS are stored.
  221.     You may create a project by explicit use of the command CREATE but it is 
  222.     automatically created if you apply the first file  to a non-existent project
  223.     (You will see a deeper discussion of the commands and their usage later).
  224.     You will have to define all files that are involved with the project to AVTS.
  225.     For you as a user there is no difference whether you handle source modules 
  226.     (ASCII text) or binary files (executables, object files, spreadsheets or text
  227.     processor documents). Once you have done that you will always follow the 
  228.     development cycle outlined below:
  229.     
  230.     - Get a file from the AVTS
  231.     - Work on it
  232.     - Give it back to keep a record of the changes.
  233.     
  234.     That's it!
  235.     
  236.     While you work on a specific module no other user is allowed to get it for 
  237.     work. They may, however, get a copy of it for reference. Perhaps you will 
  238.     also need some more modules from the project to create a test version of your
  239.     application. Then the development cycle looks like that:
  240.     
  241.     - Get the file to work on from AVTS
  242.     - Read all other files you need from AVTS
  243.     - Work on your module
  244.     - Give the modified module back
  245.     
  246.     That is enough theory for the moment. You will see some examples that show how
  247.     to work with AVTS later.
  248.     -------------------------------------------------------------------------------
  249.                                           - 4 -
  250.  
  251.     ARIS VERSION TRACKING SYSTEM                                        Version 1.0
  252.     -------------------------------------------------------------------------------
  253.     
  254.     2.    Installing ARIS Version Tracking System
  255.     
  256.     The installation of the ARIS Version Tracking System (AVTS) is very easy. 
  257.     Simply type the following command at your DOS prompt:
  258.     
  259.     A:SETUP
  260.     
  261.     and press the ENTER key. If you have the product disk in a drive other than 
  262.     A:, replace the A with the letter of the drive to be used.
  263.     You will be prompted for a directory where SETUP should install AVTS after 
  264.     some screens providing additional information. The default installation drive 
  265.     and directory is C:\AVTS. You may, however, change this to your needs. After 
  266.     supplying the path specification, SETUP copies all necessary files to the 
  267.     installation drive and directory. After this process is completed you are 
  268.     prompted, whether you want SETUP to edit the PATH statement in your 
  269.     AUTOEXEC.BAT to include the installation path in your search path. You may 
  270.     omit this step:
  271.     
  272.     - if you have already chosen a directory in the search path
  273.     - or if you want to make these changes on your own.
  274.     
  275.     Note that AVTS needs the installation directory included in the PATH 
  276.     variable to work properly.
  277.     
  278.     Once you are back to the DOS prompt, you might have to reboot your PC to 
  279.     activate the changes to your AUTOEXEC.BAT. To do this, hold down the keys 
  280.     Ctrl-Alt-Del and your system will reboot.
  281.     
  282.     Below you see a list of the files you should find in the installation 
  283.     directory with a brief description of what they are for.
  284.     
  285.     
  286.     CDC.EXE        Changes the comment of a delta.
  287.     CREATE.EXE    Creates projects and apply files to them.
  288.     DELTA.EXE    Creates a new version (delta) of a file in an AVTS project.
  289.     DIFF.EXE    Creates a listing of the differences between to versions of 
  290.             a file.
  291.     GET.EXE        Copies a project file and locks it.
  292.     HISTORY.EXE    Prints the revision history of a file in an AVTS project.
  293.     LOGVIEW.EXE    Online viewer for a project's logfile.
  294.     READ.EXE    Copies a project file without locking it.
  295.     RMALIAS.EXE    Removes an alias name from a specific version of a module.
  296.     SACT.EXE    Reports current editing activity in an AVTS project.
  297.     SETALIAS.EXE    Sets the alias name for one or more modules.
  298.     UNGET.EXE    Reverses a GET command and discards the changes.
  299.     
  300.     Since AVTS creates an audit trail of all changes applied to a project, 
  301.     it needs to know your name. For that purpose you may either specify your 
  302.     user name with an option for every command or, more conveniently, set the 
  303.     environment variable USERNAME to your login name. If you are not working in 
  304.     a network we suggest to set this variable to your last name or whatever suits 
  305.     you.
  306.     
  307.     
  308.     
  309.     
  310.     
  311.     -------------------------------------------------------------------------------
  312.                                           - 5 -
  313.  
  314.     ARIS VERSION TRACKING SYSTEM                                        Version 1.0
  315.     -------------------------------------------------------------------------------
  316.     
  317.     II.    Tutorial
  318.     
  319.     1.    Creating and editing a project
  320.     
  321.     For all of our following examples we will assume that our project has four 
  322.     source code modules written in the C language (MYAPP.C, MYMENU.C, MYFILE.C and
  323.     MYPRINT.C), two header files (MYAPP.H and MYFILE.H),  a makefile (MYAPP.MAK)
  324.     and the documentation file (MYAPP.DOC).
  325.     
  326.     We will now assume, that we have written a first version of all these files 
  327.     and will now start to introduce these files to an AVTS project.
  328.     This will be done by the following command sequence:
  329.     
  330.     set USERNAME=MYNAME
  331.     create -fMYAPP.C myapp
  332.     create -fMYMENU.C myapp
  333.     create -fMYFILE.C myapp
  334.     create -fMYPRINT.C myapp
  335.     create -fMYAPP.H myapp
  336.     create -fMYFILE.H myapp
  337.     create -fMYAPP.MAK myapp
  338.     create -fMYAPP.DOC -t1 myapp
  339.     
  340.     The last command has a parameter that makes it different from the previous 
  341.     command: -t1
  342.     This tells AVTS that this file has to be treated as binary file rather than 
  343.     as ASCII file. AVTS will not create differential listings on versions applied
  344.     to this file. Each version of this file is stored as is.
  345.     
  346.     You might now want to have a look at the log file which is updated each time 
  347.     you make a change in a project.
  348.     Assuming that you installed the AVTS in the default directory (C:\AVTS) you 
  349.     will find the log file under this name: C:\AVTS\MYAPP.RCS\RCS.LOG
  350.     This log file is a plain ASCII text file and readable by every editor. You do 
  351.     not need to remember such long paths. Simply use the utility LOGVIEW for 
  352.     viewing a project's log file.
  353.     
  354.     For the above example the log file will now look like this:
  355.     
  356.     Sun Dec 13 21:56:35 1992 User MYNAME creates MYAPP.C, version 1.0
  357.     Sun Dec 13 21:56:36 1992 User MYNAME creates MYMENU.C, version 1.0
  358.     Sun Dec 13 21:56:37 1992 User MYNAME creates MYFILE.C, version 1.0
  359.     Sun Dec 13 21:56:38 1992 User MYNAME creates MYPRINT.C, version 1.0
  360.     Sun Dec 13 21:56:39 1992 User MYNAME creates MYAPP.H, version 1.0
  361.     Sun Dec 13 21:56:40 1992 User MYNAME creates MYFILE.H, version 1.0
  362.     Sun Dec 13 21:56:41 1992 User MYNAME creates MYAPP.MAK, version 1.0
  363.     Sun Dec 13 21:56:42 1992 User MYNAME creates MYAPP.DOC, version 1.0
  364.     
  365.     Now you decide that you want to make some enhancements to the module MYFILE.C.
  366.     To make things easier, you can now set the environment variable PROJECT to 
  367.     MYAPP by using the command
  368.     
  369.     SET PROJECT=MYAPP.
  370.     
  371.     This allows you to omit the project name on the command lines of AVTS commands.
  372.     
  373.     
  374.     -------------------------------------------------------------------------------
  375.                                           - 6 -
  376.  
  377.     ARIS VERSION TRACKING SYSTEM                                        Version 1.0
  378.     -------------------------------------------------------------------------------
  379.     
  380.     Issue the following command to check MYFILE.C out:
  381.     
  382.     get MYFILE.C
  383.     
  384.     This command copies the actual version of MYFILE.C to your current directory
  385.     and locks this module for other users. You may now edit this module to apply 
  386.     the changes you have in mind without worrying about others that might change 
  387.     it while you work on it.
  388.     
  389.     For reference you might need the file MYAPP.H also, but you do not want to 
  390.     have it locked, so that another user is able to change this module. To achieve
  391.     that, issue the command:
  392.     
  393.     read MYAPP.H
  394.     
  395.     This also copies the actual version of this file to your current directory, 
  396.     but leaves the module unlocked. You may also use this command if this module 
  397.     is locked by another user.
  398.     After you have made all required changes to MYFILE.C you have to tell AVTS 
  399.     that you have made some changes to that module.
  400.     This is done by the command
  401.     
  402.     delta MYFILE.C
  403.     
  404.     After issuing this command you will be asked to enter a comment for your 
  405.     changes. You may type a character string of up to 126 characters long. 
  406.     
  407.     What if you made up your mind and decided not to change anything in a module 
  408.     you had checked out using the 'get' command? You may simply remove the lock 
  409.     flag from the module by issuing the command
  410.     
  411.     unget MYFILE.C
  412.     
  413.     This removes the lock flag of module MYFILE.C and makes it available for other
  414.     users.
  415.     
  416.     
  417.     
  418.     
  419.     
  420.     
  421.     
  422.     
  423.     
  424.     
  425.     
  426.     
  427.     
  428.     
  429.     
  430.     
  431.     
  432.     
  433.     
  434.     
  435.     
  436.     
  437.     -------------------------------------------------------------------------------
  438.                                           - 7 -
  439.  
  440.     ARIS VERSION TRACKING SYSTEM                                        Version 1.0
  441.     -------------------------------------------------------------------------------
  442.     
  443.     2.    Configuration management
  444.     
  445.     You have now learned the basic tasks for managing a project with AVTS. You can
  446.     introduce new files to a project, get files for editing and read them for 
  447.     reference. You also know how to give them back to AVTS to keep track of 
  448.     versions.
  449.     There is more to AVTS. It also allows you to keep track of your 
  450.     configuration.
  451.     In a certain project state you will decide that the current state is your 
  452.     "Beta Version 1.0". You may now give the current versions of your modules 
  453.     an alias name, that allows you to retrieve all modules belonging to this 
  454.     project state easily even if you have done major changes to your modules.
  455.     
  456.     For this purpose you have to use the command "SETALIAS". An alias name can 
  457.     be up to 79 characters in length. For our sample project you would have to 
  458.     enter the following command:
  459.     
  460.     setalias "-aBeta Version 1.0" MYAPP all
  461.     
  462.     This marks the current versions of all modules in the project MYAPP with the 
  463.     alias name "Beta Version 1.0".
  464.     If you have already tagged one or more modules with the same alias name you 
  465.     will get a warning and nothing will happen to them. If the current version of
  466.     a module already has another alias name you will also get a warning message 
  467.     and that alias name will be overwritten with the new one you specified on the
  468.     command line.
  469.     
  470.     If you want to remove an alias name from a specific version of a module you 
  471.     can use this command:
  472.     
  473.     rmalias -aaliasname module
  474.     
  475.     If you want to retrieve a configuration with a specific alias name simply 
  476.     issue the following command:
  477.     
  478.     read "-aBeta Version 1.0" MYAPP all
  479.     
  480.     This command reads all modules tagged with the alias name "Beta Version 1.0"
  481.     and copies them to your current working directory.
  482.     Please note that the quotation marks are necessary if your alias name contains
  483.     blanks.
  484.     
  485.     This mechanism provides an easy method to mark and retrieve specific project
  486.     states at every time. That way you can build up version 1.0 of an application
  487.     that is currently at version 15.99 without thinking about what modules belong
  488.     to it.
  489.     
  490.     
  491.     
  492.     
  493.     
  494.     
  495.     
  496.     
  497.     
  498.     
  499.     
  500.     -------------------------------------------------------------------------------
  501.                                           - 8 -
  502.  
  503.     ARIS VERSION TRACKING SYSTEM                                        Version 1.0
  504.     -------------------------------------------------------------------------------
  505.     
  506.     3.    Module history and editing activity
  507.     
  508.     A major point of interest is which user has done which changes and when. Some
  509.     information can be obtained by reading the project's log file. But if you need
  510.     the specific history of a module and the comments a user entered for each 
  511.     delta you will have to use the command 'HISTORY'.
  512.     
  513.     The following command retrieves all information known of a certain module and
  514.     prints it to the screen. You can easily re-direct the output of this command 
  515.     to a file or a printer. Have a look at the examples for the command 'HISTORY' 
  516.     in chapter III. REFERENCE.
  517.     
  518.     A simple example for this command is:
  519.     
  520.     history MYFILE.C
  521.     
  522.     This command prints out a editing history for the module MYFILE.C from its 
  523.     initial creation up to the current version.
  524.     
  525.     While reviewing the comments you made for specific versions of a module you 
  526.     may think that the comment you typed in when the delta command asked for it, 
  527.     doesn't really match what you wanted to say. Therefore we supplied an extra 
  528.     command that allows you to change the comment for a specific version of a 
  529.     module. Though, if you want to change the comment for i.e. version 2.9 of 
  530.     module MYAPP.C you may use the following command:
  531.     
  532.     cdc -v2.9 MYAPP MYFILE.C
  533.     
  534.     Note that if you omit the version parameter you will change the comment of 
  535.     the current version. The project name (MYAPP) may be omitted if you have set 
  536.     the environment variable PROJECT correctly.
  537.     
  538.     Another task, mainly performed by project administrators, will be to have a 
  539.     look at the current activity on a project. The command 'SACT' (System activity
  540.     report) lists all modules in a project and their current state. If a file is 
  541.     currently checked out, it also notes who owns it and at what time he checked 
  542.     it out. Please refer to chapter III. for more information about this command.
  543.     
  544.     
  545.     
  546.     
  547.     
  548.     
  549.     
  550.     
  551.     
  552.     
  553.     
  554.     
  555.     
  556.     
  557.     
  558.     
  559.     
  560.     
  561.     
  562.     
  563.     -------------------------------------------------------------------------------
  564.                                           - 9 -
  565.  
  566.     ARIS VERSION TRACKING SYSTEM                                        Version 1.0
  567.     -------------------------------------------------------------------------------
  568.     
  569.     III.    Reference
  570.     
  571.     1.    CDC - Change Delta Comment
  572.     
  573.     Synopsis
  574.     
  575.         cdc [-uusername] [-vx.y] [project name] file
  576.     
  577.     Description
  578.     
  579.         The command cdc allows changing of the comment given to a specific 
  580.         version of a file in an AVTS project. The optional parameters username
  581.         and project name can be omitted if the corresponding environment 
  582.         variables USERNAME and PROJECT are set correctly.
  583.     
  584.     Options
  585.     
  586.         -uusername    Specifies the name of the user. This option can be 
  587.                 omitted if the environment variable USERNAME is set.
  588.                 However, specifying a user's name with the -u flag 
  589.                 overrides the contents of the environment variable.
  590.     
  591.         -vx.y        This flag specifies the version of the delta for which
  592.                 you want to change the comment. If omitted the actual 
  593.                 version is used.
  594.     
  595.     
  596.     Examples
  597.     
  598.         1.    To change the delta comment of the current version of file 
  599.             MYAPP.C in the project MYAPP:
  600.     
  601.             cdc MYAPP MYAPP.C
  602.     
  603.             This shows you the current contents of the comment and prompts
  604.             you for the new comment in the following form:
  605.     
  606.             ARIS Version Tracking System 1.0
  607.             (c) 1992,1993 All rights reserved
  608.             File MYAPP.C, created Sun Dec 13 21:56:35 1992
  609.             Version 1.2, derived from version 1.1
  610.             Comment: Debugging in progress...
  611.             New comment:
  612.     
  613.         2.    To change the comment of a specific version of MYAPP.C:
  614.     
  615.             cdc -v1.1 MYAPP MYAPP.C
  616.     
  617.     
  618.     
  619.     
  620.     
  621.     
  622.     
  623.     
  624.     
  625.     
  626.     -------------------------------------------------------------------------------
  627.                                           - 10 -
  628.  
  629.     ARIS VERSION TRACKING SYSTEM                                        Version 1.0
  630.     -------------------------------------------------------------------------------
  631.     
  632.     2.    CREATE - Creates projects and apply files to them.
  633.     
  634.     Synopsis
  635.     
  636.         create [-uusername] [-ffile] [-ttype] projectname
  637.     
  638.     Description
  639.     
  640.         The command create allows creation of a new project and/or adding 
  641.         files to a project. If there is no file specified with the -f flag the
  642.         project is created. However, if you add a file with the -f flag to a 
  643.         non-existant project, the project is created automatically. The 
  644.         parameter -uusername can be omitted if the environment variable 
  645.         USERNAME is set correctly.
  646.     
  647.     Options
  648.     
  649.         -uusername    Specifies the name of the user. This option can be 
  650.                 omitted if the environment variable USERNAME is set.
  651.                 However, specifying a user's name with the -u flag 
  652.                 overrides the contents of the environment variable.
  653.     
  654.         -ffile        Specifies the name of a file that should be added to 
  655.                 the project. The name must not include path 
  656.                 specifications or wildcard characters. If the 
  657.                 specified file is not available the process will be 
  658.                 aborted.
  659.     
  660.         -ttype        Specifies the type of a new file. Legal values are 0 
  661.                 (null) for ASCII files and 1 (one) for binary files. 
  662.                 If this option is omitted the default value 0 (null) 
  663.                 will be used.
  664.     
  665.     Examples:
  666.     
  667.         1.    To create a new project NEWPRO:
  668.     
  669.             create NEWPRO
  670.     
  671.         2.    To add the source file MYAPP.C to the project NEWPRO:
  672.     
  673.             create -fMYAPP.C NEWPRO
  674.     
  675.         3.    To add the binary file MYAPP.DBF to the project NEWPRO
  676.     
  677.             create -fMYAPP.DBF -t1 NEWPRO
  678.     
  679.     
  680.     
  681.     
  682.     
  683.     
  684.     
  685.     
  686.     
  687.     
  688.     
  689.     -------------------------------------------------------------------------------
  690.                                           - 11 -
  691.  
  692.     ARIS VERSION TRACKING SYSTEM                                        Version 1.0
  693.     -------------------------------------------------------------------------------
  694.     
  695.     3.    DELTA - Creates a new version (delta) of a file in an AVTS project.
  696.     
  697.     Synopsis
  698.     
  699.         delta [-uusername] projectname file
  700.     
  701.     Description
  702.     
  703.         The delta command creates a new version of file. The file must have 
  704.         been checked out with the command get by the same user. Otherwise you 
  705.         will get an error message that either the file has not been checked 
  706.         out or has been checked out by another user. See appendix A for a list
  707.         of error messages.
  708.         You will be prompted for a comment on the changes. The maximum length 
  709.         of the comment string is 127 characters.
  710.     
  711.     Options
  712.     
  713.         -uusername    Specifies the name of the user. This option can be 
  714.                 omitted if the environment variable USERNAME is set. 
  715.                 However, specifying a user's name with the -u flag 
  716.                 overrides the contents of the environment variable.
  717.     
  718.     
  719.     Example
  720.     
  721.         To create a new version of MYAPP.C in the project MYAPP:
  722.     
  723.         delta MYAPP MYAPP.C
  724.     
  725.     
  726.     
  727.     
  728.     
  729.     
  730.     
  731.     
  732.     
  733.     
  734.     
  735.     
  736.     
  737.     
  738.     
  739.     
  740.     
  741.     
  742.     
  743.     
  744.     
  745.     
  746.     
  747.     
  748.     
  749.     
  750.     
  751.     
  752.     -------------------------------------------------------------------------------
  753.                                           - 12 -
  754.  
  755.     ARIS VERSION TRACKING SYSTEM                                        Version 1.0
  756.     -------------------------------------------------------------------------------
  757.     
  758.     4.    DIFF - Compares two files and creates a difference listing
  759.     
  760.     Synopsis
  761.     
  762.         diff [-s] [-mnum] oldfile newfile
  763.     
  764.     Description
  765.     
  766.         The command diff is a program that is used by the delta command to 
  767.         create a difference listing when a new version of an ASCII file is 
  768.         applied to a project. You may however, also use this command to create
  769.         difference listings for your own use.
  770.         From the output of the diff command you can see what changes must be 
  771.         made in oldfile to get newfile. The output has the following form:
  772.     
  773.         n1,n2d        delete lines n1 to n2 from file oldfile.
  774.     
  775.         n1,n2cm1,m2    Replace the lines n1 to n2 in file oldfile by the 
  776.                 lines m1 to m2 from file newfile.
  777.     
  778.         n1am1,m2    Insert lines m1 to m2 from file newfile in file 
  779.                 oldfile after line n1.
  780.     
  781.     
  782.     Options
  783.     
  784.         -s    Creates a script which can be used to convert oldfile to 
  785.             newfile.
  786.     
  787.         -mnum    num specifies how many subsequent lines have to be equal to 
  788.             synchronise.
  789.     
  790.     
  791.     
  792.     
  793.     
  794.     
  795.     
  796.     
  797.     
  798.     
  799.     
  800.     
  801.     
  802.     
  803.     
  804.     
  805.     
  806.     
  807.     
  808.     
  809.     
  810.     
  811.     
  812.     
  813.     
  814.     
  815.     -------------------------------------------------------------------------------
  816.                                           - 13 -
  817.  
  818.     ARIS VERSION TRACKING SYSTEM                                        Version 1.0
  819.     -------------------------------------------------------------------------------
  820.     
  821.     5.    GET - Copies a project file and locks it
  822.     
  823.     Synopsis
  824.     
  825.         get [-uusername] projectname filename
  826.     
  827.     Description
  828.     
  829.         The command get copies a file from a project to the current working 
  830.         directory and locks it in the project. Therefore another user cannot 
  831.         "get" this file until it is checked in by the command delta or the 
  832.         lock is removed by the command unget. Other users may obtain a copy 
  833.         of a locked module by using the command read. The optional parameters 
  834.         username and project name can be omitted if the corresponding 
  835.         environment variables USERNAME and PROJECT are set correctly.
  836.     
  837.     Options
  838.     
  839.         -uusername    Specifies the name of the user. This option can be 
  840.                 omitted if the environment variable USERNAME is set.
  841.                 However, specifying a user's name with the -u flag 
  842.                 overrides the contents of the environment variable.
  843.     
  844.     
  845.     
  846.     
  847.     
  848.     
  849.     
  850.     
  851.     
  852.     
  853.     
  854.     
  855.     
  856.     
  857.     
  858.     
  859.     
  860.     
  861.     
  862.     
  863.     
  864.     
  865.     
  866.     
  867.     
  868.     
  869.     
  870.     
  871.     
  872.     
  873.     
  874.     
  875.     
  876.     
  877.     
  878.     -------------------------------------------------------------------------------
  879.                                           - 14 -
  880.  
  881.     ARIS VERSION TRACKING SYSTEM                                        Version 1.0
  882.     -------------------------------------------------------------------------------
  883.     
  884.     6.    HISTORY - Prints the revision history of a file in an AVTS project
  885.     
  886.     Synopsis
  887.     
  888.         history [-uusername] [-vx.y] projectname file
  889.     
  890.     Description
  891.     
  892.         The command history prints out all activities that occured on file 
  893.         from the initial creation to the current version or, if supplied, to 
  894.         the version specified with the -v parameter. The optional parameters 
  895.         username and projectname can be omitted if the corresponding 
  896.         environment variables USERNAME and PROJECT are set correctly.
  897.     
  898.     
  899.     Options
  900.     
  901.         -uusername    Specifies the name of the user. This option can be 
  902.                 omitted if the environment variable USERNAME is set.
  903.                 However, specifying a user's name with the -u flag 
  904.                 overrides the contents of the environment variable.
  905.     
  906.         -vx.y        This flag specifies the version of the module where 
  907.                 the printout of the history should stop. If omitted 
  908.                 the actual version is used.
  909.     
  910.     
  911.     Examples
  912.     
  913.         1.    List the revision history of MYAPP.C in project MYAPP:
  914.     
  915.             history MYAPP MYAPP.C
  916.     
  917.         2.    View the revision history of MYAPP.C page by page:
  918.     
  919.             history MYAPP MYAPP.C | more
  920.     
  921.         3.    Print the history of MYAPP.C up to version 2.5 on a parallel 
  922.             printer:
  923.     
  924.             history -v2.5 MYAPP MYAPP.C >prn
  925.     
  926.     
  927.     
  928.     
  929.     
  930.     
  931.     
  932.     
  933.     
  934.     
  935.     
  936.     
  937.     
  938.     
  939.     
  940.     
  941.     -------------------------------------------------------------------------------
  942.                                           - 15 -
  943.  
  944.     ARIS VERSION TRACKING SYSTEM                                        Version 1.0
  945.     -------------------------------------------------------------------------------
  946.     
  947.     7.    LOGVIEW - View the contents of a project's logfile
  948.     
  949.     Synopsis
  950.     
  951.         logview project
  952.     
  953.     Description
  954.     
  955.         The utility logview allows you to easily browse through the log file 
  956.         of the specified project. The parameter project can be omitted if the 
  957.         environment variable PROJECT is set to the correct value.
  958.     
  959.     
  960.     
  961.     
  962.     
  963.     
  964.     
  965.     
  966.     
  967.     
  968.     
  969.     
  970.     
  971.     
  972.     
  973.     
  974.     
  975.     
  976.     
  977.     
  978.     
  979.     
  980.     
  981.     
  982.     
  983.     
  984.     
  985.     
  986.     
  987.     
  988.     
  989.     
  990.     
  991.     
  992.     
  993.     
  994.     
  995.     
  996.     
  997.     
  998.     
  999.     
  1000.     
  1001.     
  1002.     
  1003.     
  1004.     -------------------------------------------------------------------------------
  1005.                                           - 16 -
  1006.  
  1007.     ARIS VERSION TRACKING SYSTEM                                        Version 1.0
  1008.     -------------------------------------------------------------------------------
  1009.     
  1010.     8.    READ - Copies a project file without locking
  1011.     
  1012.     Synopsis
  1013.     
  1014.         read [-uusername] [[-vx.y] | [-aalias]] project file
  1015.     
  1016.     Description
  1017.     
  1018.         The command read copies the specified file from project to the current
  1019.         working directory. The retrieved module is not locked and therefore 
  1020.         still available for other users. If you specify 'all' instead of a 
  1021.         file's name all files in the project are copied. If no version is 
  1022.         specified with the -v flag, the current version is used. The optional 
  1023.         parameters username and projectname can be omitted if the 
  1024.         corresponding environment variables USERNAME and PROJECT are set 
  1025.         correctly.
  1026.     
  1027.     Options
  1028.     
  1029.         -uusername    Specifies the name of the user. This option can be 
  1030.                 omitted if the environment variable USERNAME is set.
  1031.                 However, specifying a user's name with the -u flag 
  1032.                 overrides the contents of the environment variable.
  1033.     
  1034.         -vx.y        This flag specifies the version of the module which 
  1035.                 should be retrieved. If omitted the actual version is 
  1036.                 used. This option is not allowed in combination with 
  1037.                 the -a flag.
  1038.     
  1039.         -aalias        This copies the version that has the given alias name.
  1040.                 If there is no such version you will get an error 
  1041.                 message.
  1042.     
  1043.     Examples
  1044.     
  1045.         1.    Read the file MYFILE.C from project MYAPP:
  1046.     
  1047.             read MYAPP MYFILE.C
  1048.     
  1049.         2.    Read version 1.5 of MYFILE.C from project MYAPP:
  1050.     
  1051.             read -v1.5 MYAPP MYFILE.C
  1052.     
  1053.         3.    Read all file from project MYAPP that belong to "Beta Version 1.0":
  1054.     
  1055.             read "-aBeta Version 1.0" MYAPP all
  1056.     
  1057.             Please note that the quotation marks are necessary because the
  1058.             alias name contains space characters.
  1059.     
  1060.     
  1061.     
  1062.     
  1063.     
  1064.     
  1065.     
  1066.     
  1067.     -------------------------------------------------------------------------------
  1068.                                           - 17 -
  1069.  
  1070.     ARIS VERSION TRACKING SYSTEM                                        Version 1.0
  1071.     -------------------------------------------------------------------------------
  1072.     
  1073.     9.    RMALIAS - Removes an alias name from a specific version of a module
  1074.     
  1075.     Synopsis
  1076.     
  1077.         rmalias [-uusername] -aalias project file
  1078.     
  1079.     Description
  1080.     
  1081.         The command rmalias removes an alias name from the module specified by
  1082.         file. If 'all' is specified instead of a filename, the alias name is 
  1083.         removed from all modules in the specified project. The optional 
  1084.         parameters username and project can be omitted if the corresponding 
  1085.         environment variables USERNAME and PROJECT are set correctly.
  1086.     
  1087.     Options
  1088.     
  1089.         -uusername    Specifies the name of the user. This option can be 
  1090.                 omitted if the environment variable USERNAME is set. 
  1091.                 However, specifying a user's name with the -u flag 
  1092.                 overrides the contents of the environment variable.
  1093.     
  1094.         -aalias        This specifies the alias name that should be removed.
  1095.                 If there is no such alias you will get an error 
  1096.                 message.
  1097.     
  1098.     
  1099.     Examples
  1100.     
  1101.         1.    Remove the alias "BETA" from module MYFILE.C in project MYAPP:
  1102.     
  1103.             rmalias -aBETA MYAPP MYFILE.C
  1104.     
  1105.         2.    Remove the alias "BETA" from all files in project MYAPP:
  1106.     
  1107.             rmalias -aBETA MYAPP all
  1108.     
  1109.     
  1110.     
  1111.     
  1112.     
  1113.     
  1114.     
  1115.     
  1116.     
  1117.     
  1118.     
  1119.     
  1120.     
  1121.     
  1122.     
  1123.     
  1124.     
  1125.     
  1126.     
  1127.     
  1128.     
  1129.     
  1130.     -------------------------------------------------------------------------------
  1131.                                           - 18 -
  1132.  
  1133.     ARIS VERSION TRACKING SYSTEM                                        Version 1.0
  1134.     -------------------------------------------------------------------------------
  1135.     
  1136.     10.    SACT - Reports current editing activity in an AVTS project
  1137.     
  1138.     Synopsis
  1139.     
  1140.         sact [-uusername] [-l] project
  1141.     
  1142.     Description
  1143.     
  1144.         The command sact prints out for each file in project whether it is 
  1145.         currently checked out and by whom or not. The optional parameter 
  1146.         username can be omitted if the corresponding environment variable 
  1147.         USERNAME is set correctly.
  1148.     
  1149.     Options
  1150.     
  1151.         -uusername    Specifies the name of the user. This option can be 
  1152.                 omitted if the environment variable USERNAME is set.
  1153.                 However, specifying a user's name with the -u flag 
  1154.                 overrides the contents of the environment variable.
  1155.     
  1156.         -l        If specified, sact will only display those files, that
  1157.                 are currently locked in the project. Unlocked files 
  1158.                 will not appear in the list.
  1159.     
  1160.     
  1161.     
  1162.     
  1163.     
  1164.     
  1165.     
  1166.     
  1167.     
  1168.     
  1169.     
  1170.     
  1171.     
  1172.     
  1173.     
  1174.     
  1175.     
  1176.     
  1177.     
  1178.     
  1179.     
  1180.     
  1181.     
  1182.     
  1183.     
  1184.     
  1185.     
  1186.     
  1187.     
  1188.     
  1189.     
  1190.     
  1191.     
  1192.     
  1193.     -------------------------------------------------------------------------------
  1194.                                           - 19 -
  1195.  
  1196.     ARIS VERSION TRACKING SYSTEM                                        Version 1.0
  1197.     -------------------------------------------------------------------------------
  1198.     
  1199.     11.    SETALIAS - Sets the alias name for one or more modules
  1200.     
  1201.     Synopsis
  1202.     
  1203.         setalias [-uusername] [-vx.y] -aalias project file
  1204.     
  1205.     Description
  1206.     
  1207.         The command setalias sets an alias name for the specified file. If 
  1208.         'all' is  given  instead of a filename, all files in the specified 
  1209.         project will get this alias name. If there is no version specified 
  1210.         with the -v flag, the current version of file will be used. If you 
  1211.         have already tagged another version of  the specified  module with 
  1212.         the same alias name you will get a warning and nothing will happen. 
  1213.         If the specified version of a module has already another alias name 
  1214.         you will also get a warning message and the alias name will be over-
  1215.         written with the new one you specified with the -a flag. The optional
  1216.         parameters username and project can be omitted if the corresponding 
  1217.         environment variables USERNAME and PROJECT are set correctly.
  1218.     
  1219.     Options
  1220.     
  1221.         -uusername    Specifies the name of the user. This option can be 
  1222.                 omitted if the environment variable USERNAME is set.
  1223.                 However, specifying a user's name with the -u flag 
  1224.                 overrides the contents of the environment variable.
  1225.     
  1226.         -vx.y        Specifies the version of the module which should get 
  1227.                 an alias name.
  1228.     
  1229.         -aalias        Specifies the alias name which should be used for the 
  1230.                 file. Maximum length is 78 characters.
  1231.     
  1232.     Example
  1233.     
  1234.         Tag the current versions of all file in project MYAPP with the alias 
  1235.         name "BETA":
  1236.     
  1237.         setalias -aBETA MYAPP all
  1238.     
  1239.     
  1240.     
  1241.     
  1242.     
  1243.     
  1244.     
  1245.     
  1246.     
  1247.     
  1248.     
  1249.     
  1250.     
  1251.     
  1252.     
  1253.     
  1254.     
  1255.     
  1256.     -------------------------------------------------------------------------------
  1257.                                           - 20 -
  1258.  
  1259.     ARIS VERSION TRACKING SYSTEM                                        Version 1.0
  1260.     -------------------------------------------------------------------------------
  1261.     
  1262.     12.    UNGET - Reverses a GET command without creating a new version
  1263.     
  1264.     Synopsis
  1265.     
  1266.         unget [-uusername] project file
  1267.     
  1268.     Description
  1269.     
  1270.         The command unget unlocks a file previously locked with the get 
  1271.         command. Any changes on a file are ignored and the version counter is
  1272.         not increased. The optional parameters username and project can be 
  1273.         omitted if the corresponding environment variables USERNAME and 
  1274.         PROJECT are set correctly.
  1275.     
  1276.     Options
  1277.     
  1278.         -uusername    Specifies the name of the user. This option can be 
  1279.                 omitted if the environment variable USERNAME is set.
  1280.                 However, specifying a user's name with the -u flag 
  1281.                 overrides the contents of the environment variable.
  1282.     
  1283.     
  1284.     
  1285.     
  1286.     
  1287.     
  1288.     
  1289.     
  1290.     
  1291.     
  1292.     
  1293.     
  1294.     
  1295.     
  1296.     
  1297.     
  1298.     
  1299.     
  1300.     
  1301.     
  1302.     
  1303.     
  1304.     
  1305.     
  1306.     
  1307.     
  1308.     
  1309.     
  1310.     
  1311.     
  1312.     
  1313.     
  1314.     
  1315.     
  1316.     
  1317.     
  1318.     
  1319.     -------------------------------------------------------------------------------
  1320.                                           - 21 -
  1321.  
  1322.     ARIS VERSION TRACKING SYSTEM                                        Version 1.0
  1323.     -------------------------------------------------------------------------------
  1324.     
  1325.     IV.    APPENDIX A - ERROR MESSAGES
  1326.     
  1327.     Delta was created by another user, access denied
  1328.     
  1329.         You tried to change the delta comment of a version that was created 
  1330.         by another user. Use the history command to obtain information about
  1331.         this module and contact the user who created this module.
  1332.     
  1333.     File filename already in project projectname
  1334.     
  1335.         You tried to introduce a file to a  project that is already in that 
  1336.         project with the create command.
  1337.      
  1338.     File name already in use
  1339.     
  1340.         You tried to do an action on a file that is currently checked out. For
  1341.         further information use the command sact which provides useage 
  1342.         information for each file in a project.
  1343.     
  1344.     File name already in use by user username
  1345.     
  1346.         The specified file is currently checked out by another user. You 
  1347.         cannot complete the desired action until this user checks the file in
  1348.         again.
  1349.     
  1350.     File name checked out by username, access denied
  1351.     
  1352.         You tried to modify the information of a file that is currently 
  1353.         checked out by another user.
  1354.     
  1355.     
  1356.     File name is not checked out
  1357.     
  1358.         You tried to create a delta on a file that is not checked out. If you
  1359.         modified a file you obtained with the read command this error can be 
  1360.         overcome by doing the following actions:
  1361.     
  1362.         -    rename the file you want to check in (file.BAK).
  1363.         -    Use the get command to lock the desired file on your user-id.
  1364.         -    rename the file back to its original name.
  1365.         -    use the delta command.
  1366.     
  1367.         Note that it is recommended to check the project log file first if to
  1368.         ensure that no other user made modifications to that file in the 
  1369.         meantime.
  1370.     
  1371.     File name is not checked out, cannot unget
  1372.     
  1373.         You tried to use the unget command for a file that is not checked out.
  1374.     
  1375.     File name not in project
  1376.     
  1377.         You specified a file for an AVTS command that is not found in the 
  1378.         project specified. Check the environment variable PROJECT and the 
  1379.         spelling of the issued command.
  1380.     
  1381.     
  1382.     -------------------------------------------------------------------------------
  1383.                                           - 22 -
  1384.  
  1385.     ARIS VERSION TRACKING SYSTEM                                        Version 1.0
  1386.     -------------------------------------------------------------------------------
  1387.     
  1388.     Internal failure, not found name
  1389.     
  1390.         Please contact ARIS support immediately if this error occurs.
  1391.     
  1392.     Missing argument
  1393.     
  1394.         A required argument, such as file- or projectname have not been 
  1395.         specified. Check the typing of the issued command.
  1396.     
  1397.     Missing file name
  1398.     
  1399.         You did not specify a filename where it was required.
  1400.     
  1401.     Missing project name
  1402.     
  1403.         You did not specify a project name where it was required.
  1404.     
  1405.     Project name already exists
  1406.     
  1407.         You tried to create a new project with the create command which 
  1408.         already exists. Use another name.
  1409.     
  1410.     Projects is locked, access denied
  1411.         
  1412.         An AVTS command was not able to lock the project directory file after
  1413.         ten attempts. This may be caused by heavy use of the system. Repeat 
  1414.         your command and contact your network administrator if it occurs 
  1415.         again.
  1416.     
  1417.     
  1418.     Unable to create name
  1419.     
  1420.         An AVTS command was unable to create the file specified by name. This
  1421.         might be caused by several reasons:
  1422.     
  1423.         1.    Your disk has no more free space
  1424.         2.    Your disk is write protected
  1425.         3.    The file specified by name already exists and has a read-only
  1426.             or a system attribute.
  1427.         4.    On a network drive you may have no write access to the 
  1428.             current directory, contact your system administrator for 
  1429.             further information.
  1430.     
  1431.     Unable to create file name
  1432.     
  1433.         See above message for explanation.
  1434.     
  1435.     Unable to open input file name
  1436.     
  1437.         The file you specified cannot be opened. This may either be caused by
  1438.         a misspelling or insufficient access rights in a network environment.
  1439.     
  1440.     
  1441.     
  1442.     
  1443.     
  1444.     
  1445.     -------------------------------------------------------------------------------
  1446.                                           - 23 -
  1447.  
  1448.     ARIS VERSION TRACKING SYSTEM                                        Version 1.0
  1449.     -------------------------------------------------------------------------------
  1450.     Unable to open RCS.DAT
  1451.     
  1452.         If this happens on a newly created project, you have not yet added 
  1453.         files to the project. Therefore no project directory exists. If you 
  1454.         where able to access the project before, your disk may have been 
  1455.         corrupted. Check the file system and use your backup to restore the 
  1456.         project.
  1457.     
  1458.     Username unknown
  1459.     
  1460.         There is no username specified. You must either use the -u command 
  1461.         line switch or the environment variable USERNAME to specify a name.
  1462.     
  1463.     
  1464.     
  1465.     
  1466.     
  1467.     
  1468.     
  1469.     
  1470.     
  1471.     
  1472.     
  1473.     
  1474.     
  1475.     
  1476.     
  1477.     
  1478.     
  1479.     
  1480.     
  1481.     
  1482.     
  1483.     
  1484.     
  1485.     
  1486.     
  1487.     
  1488.     
  1489.     
  1490.     
  1491.     
  1492.     
  1493.     
  1494.     
  1495.     
  1496.     
  1497.     
  1498.     
  1499.     
  1500.     
  1501.     
  1502.     
  1503.     
  1504.     
  1505.     
  1506.     
  1507.     
  1508.     -------------------------------------------------------------------------------
  1509.                                           - 24 -
  1510.