home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 14 Text / 14-Text.zip / srcsafe.zip / TUTORI.ZIP / TUTORIAL.TXT < prev   
Text File  |  1993-11-20  |  10KB  |  287 lines
  1. ** Congratulations! **
  2.  
  3. You are about to discover one of the most powerful tools yet designed to
  4. organize and track your source code files.
  5.  
  6. SourceSafe tracks teams of programmers on a LAN, making sure they don't
  7. overwrite each other's code.
  8.  
  9. SourceSafe stores source code histories, so you can retrieve old versions of
  10. a file--or of an entire program or system!
  11.  
  12. SourceSafe tracks modular code--that is, it remembers which programs use
  13. which reusable files.
  14.  
  15. SourceSafe provides a comprehensive multi-platform solution, with one unified
  16. code database accessible from DOS, Windows, Windows/NT, OS/2, UNIX, and the
  17. Macintosh.
  18.  
  19. This demo is a full working copy of SourceSafe, limited only by a 30-day
  20. timeout (and without the 200-page User's Manual that accompanies the actual
  21. product).  The recommended usage is to start with the tutorials in this
  22. document, and then actually integrate SourceSafe into your daily work for 30
  23. days: this provides the most efficient, thorough evaluation of how the
  24. product fits into your development environment.
  25.  
  26. For maximum convenience, you may wish to print this document.  Unlimited
  27. permission is granted to reproduce this document any any quantity for use
  28. with the SourceSafe demonstration product.
  29.  
  30.  
  31. ** Getting Started with the SourceSafe Demo **
  32.  
  33. * Installing SourceSafe *
  34.  
  35. 1. Users of Microsoft Windows must exit Windows before running the SourceSafe
  36. INSTALL program.
  37.  
  38. The SourceSafe INSTALL program for DOS and Windows will not run successfully
  39. under Microsoft Windows!
  40.  
  41. 2. Run the program INSTALL from this disk.
  42.  
  43. The INSTALL program will ask a few simple questions (such as "what directory
  44. should SourceSafe be installed to?) and will then create a complete
  45. SourceSafe installation on your hard drive or network.  After INSTALL is
  46. through, you can immediately start running SourceSafe as the user GUEST.  It
  47. is preferable, however, to start by adding a few real names to the SourceSafe
  48. user list.
  49.  
  50. * Adding Names to the SourceSafe User List *
  51.  
  52. 1. Underneath the directory you installed SourceSafe to is a directory called
  53. ADMIN (for DOS and Windows users only) or OS2.  Run the program SSADMIN in
  54. this directory.
  55.  
  56. Windows users may notice that the SSADMIN program on this demo is DOS-based
  57. (although, unlike the INSTALL program, it can be run under Windows).  The
  58. shipping version of SourceSafe comes with a Windows-based SSADMIN program.
  59.  
  60. 2. Choose the "Add User" menu option to add a user.
  61.  
  62. Enter the name of a SourceSafe user, and (optionally) a password.  If
  63. possible, make sure every user's SourceSafe name is the same as his network
  64. username.  When you are done, hit Okay to add the user.  (DOS and Windows
  65. users without a mouse can use Alt-O for Okay.)
  66.  
  67. 3. Repeat as necessary, then exit.
  68.  
  69. That is, add all the users who will be running the SourceSafe demo.  When you
  70. are done, choose the "Exit" menu option to exit the SSADMIN program.
  71.  
  72.  
  73. ** Tutorial: Your First SourceSafe Session **
  74.  
  75. This tutorial will take 15-30 minutes, at the end of which you will be
  76. familiar with SourceSafe's interface and basic concepts.  Of course, many of
  77. the more powerful features discussed in the SourceSafe User's Manual and On-
  78. Line Help are not covered in this beginning tour.
  79.  
  80. * Running SourceSafe and Logging In *
  81.  
  82. 1. Run the program SSD.EXE (DOS), SSW.EXE (Windows), or SSOS2.EXE (OS/2).
  83.  
  84. At this point, the SourceSafe login box may come up.  If it does not, skip
  85. down to "Create a Project!"
  86.  
  87. 2. Type your SourceSafe username (or GUEST), hit <Tab>, type your SourceSafe
  88. password, and hit <Enter>.
  89.  
  90. You are now logged into SourceSafe, seeing the main SourceSafe screen for the
  91. first time.
  92.  
  93. * Create a Project! *
  94.  
  95. The first step in starting a program in SourceSafe is creating a "project" to
  96. hold the files for the program.
  97.  
  98. 1. Choose the "Create Project" option from the "File" menu.
  99.  
  100. 2. Type your initials (or any other name, such as "MyProject" or
  101. "Hardware_Driver").
  102.  
  103. 3. <Tab> to the Comment box, and type a comment.
  104.  
  105. For instance, "This is a dummy project being created for the SourceSafe
  106. tutorial."
  107.  
  108. 4. Push the Okay button to Create the project.
  109.  
  110. DOS users will need to know the following rule: use the alt-key, in
  111. combination with the highlighted letter, to activate buttons and other
  112. controls.  For instance, hit Alt-O to "push" the Okay button.
  113.  
  114. 5. Select the project you just created.
  115.  
  116. Mouse users can simply single-click on the project in the project tree:
  117. keyboard users can <Tab> to the project tree, then use the up-and-down arrows
  118. to select the project.  Selecting sets your "current project"; the next steps
  119. you take will assume that you have set the current project correctly.
  120.  
  121. * Set a Working Directory *
  122.  
  123. The first step in beginning to work on any project is setting your personal
  124. "Working Directory" for that project.
  125.  
  126. 1. Choose "Working Directory" from the Setup menu.
  127.  
  128. 2. Use the "Directories" and "Drives" boxes to navigate to your personal
  129. working directory for the project.
  130.  
  131. You can also use the "Create" button to create a new directory to act as your
  132. working directory.
  133.  
  134. 3. Turn the "Save as Default for Project" checkbox on.
  135.  
  136. DOS users, remembering the button rule discussed above, can use "Alt-P" to
  137. flip this checkbox to [Y].
  138.  
  139. 4. Press Okay to save your personal working directory for the current
  140. project.
  141.  
  142. The bottom-left-hand corner of the SourceSafe window will change to reflect
  143. your new working directory.
  144.  
  145. * Add a File to SourceSafe *
  146.  
  147. Adding a file means copying it from a directory into the current project.
  148.  
  149. 1. Choose "Add..." from the SourceSafe menu.
  150.  
  151. 2. Using the "Directories" and "Drives" boxes, go to the "Users\Guest"
  152. subdirectory under the SourceSafe directory.
  153.  
  154. 3. In the "Files" list, choose the file HELP.C.
  155.  
  156. This is the dummy file which has been provided for this tutorial.  Of course,
  157. you can instead choose any other file from any other directory and drive if
  158. you like.
  159.  
  160. 4. Push the "Add" button.  You will then be prompted for a comment: type one
  161. and press Okay.  Finally, Close the Add dialog box.
  162.  
  163. * Retrieve That File *
  164.  
  165. HELP.C is now in the SourceSafe database.  In the normal course of running
  166. SourceSafe, you will frequently want to retrieve it--that is, copy it into
  167. your working directory.
  168.  
  169. 1. <Tab> to the file list, and select the file HELP.C.
  170.  
  171. 2. Choose Get from the SourceSafe menu.
  172.  
  173. SourceSafe has not been changed at all, but a copy of the file HELP.C now
  174. exists in your working directory.  You may want to confirm this fact before
  175. proceeding.
  176.  
  177. 3. Select HELP.C again and choose Checkout from the SourceSafe menu.
  178.  
  179. Once again, SourceSafe copies the file into your working directory--but this
  180. time, it marks the file for editing.
  181.  
  182. 4. Modify the file using your favorite text editor.
  183.  
  184. Make some change to the file (not the file in USERS\GUEST, but the copy you
  185. just Checked out to the working directory).  DOS users will need to exit
  186. SourceSafe to do this, and then re-run it.
  187.  
  188. 5. Select HELP.C and choose Difference... from the Info menu.
  189.  
  190. This command does nothing to SourceSafe: it simply displays, for your
  191. information, the changes you have made.  Hit <Esc> to close the Difference
  192. dialog box.
  193.  
  194. 6. Select HELP.C and choose Update... from the SourceSafe menu.
  195.  
  196. After you press Okay, the file will be Updated in SourceSafe and your change
  197. recorded.  Other users can now check out and modify the file.
  198.  
  199. * An Historical Digression *
  200.  
  201. 1. Select HELP.C and choose History from the Info menu.
  202.  
  203. History shows you every version in the history of this file, and allows you
  204. to View or Get the old versions.
  205.  
  206. 2. Press F1 to get Help on the History dialog box.
  207.  
  208. SourceSafe's Help is context-sensitive; so when you hit F1, you get help on
  209. the dialog box you are currently in.  Inside the help screen, use the up-and-
  210. down arrows to move among the highlighted words and scroll the text; hit
  211. <Enter> on any word to jump to help on a related topic.
  212.  
  213. 3. Press <Esc> to exit the dialog box, and again to exit SourceSafe itself.
  214.  
  215.  
  216. ** The SourceSafe Command-Line **
  217.  
  218. The command-line provides an alternative entry point which is frequently
  219. faster than running the user-interface.  It is highly recommended that you go
  220. through the user-interface tutorial first: then use the following
  221. instructions to see the command-line equivalents of the SourceSafe operations
  222. you already understand.
  223.  
  224. 1. Put the SS.EXE directory in your path.
  225.  
  226. For DOS users, this is the SourceSafe directory itself; for OS/2 users, the
  227. OS2 subdirectory.  There is no command line with the Windows version of
  228. SourceSafe.
  229.  
  230. 2. Set the environment variable SSUSER to your SourceSafe username.
  231.  
  232. This step is unnecessary for Novell NetWare users, since SourceSafe can find
  233. your login name from your network.
  234.  
  235. 3. Type SS CP $/
  236.  
  237. Comparable to the CD (Change Directory) command, CP sets your current
  238. project: in this case, to the root project $/
  239.  
  240. 4. Type SS Create Project2
  241.  
  242. SourceSafe asks for a comment: type any comment, as long as you like, and hit
  243. the <Enter> key.  The project is now created under the current project.
  244.  
  245. 5. Type SS Dir
  246.  
  247. This command displays all the files and projects under the current project,
  248. and is therefore one of the most commonly used in the command-line.
  249.  
  250. 6. Type SS CP Project2 to switch into the project you have created.
  251.  
  252. 7. Change directory to your personal working directory for the project.
  253.  
  254. 8. Type SS Add <the file HELP.C in the SourceSafe USERS\GUEST subdirectory>.
  255.  
  256. You may want to try SS Dir again to confirm that the file has been added to
  257. the current project.
  258.  
  259. 9. Type SS Get HELP.C
  260.  
  261. This Gets a copy of the file into your current directory.
  262.  
  263. 10. Type SS Checkout HELP.C
  264.  
  265. This is similar to Get, but indicates that you will be modifying the file. 
  266. You may want to try typing SS Status to get a list of all the checked-out
  267. files in this project.
  268.  
  269. 11. Modify the file using your favorite text editor.
  270.  
  271. 12. Type SS Diff HELP.C
  272.  
  273. This displays the changes you have made.
  274.  
  275. 13. Type SS Update HELP.C
  276.  
  277. This Updates SourceSafe's copy of HELP.C with the changes you have made.
  278.  
  279. 14. Type SS History HELP.C
  280.  
  281. This shows all the old versions of HELP.C.
  282.  
  283. 15. Type SS Help History
  284.  
  285. Similar to pressing F1 in the user-interface, the command SS Help is your
  286. command-line window into the SourceSafe Help system.
  287.