Documentation/user-manual.txt

   1 Subsurface 1.2
   2
   3 User Manual
   4
   5 Version 0.0.1
   6
   7 (c) subsurface - Linus Torvalds 2011
   8
   9
  10 Autor documentation: Jacco van Koll
  11
  12
  13 Scope of this document is the usage of the program.
  14 Please read the build manual for instructions how to build the
  15 software and (if needed) it´s dependencies.
  16
  17
  18 Audience: Fun Divers, Tec Divers, Professional Divers
  19
  20
  21 1. Introduction:
  22
  23 Besides his family, Linus has another hobby. This is diving. He tries to dive
  24 on nice spots whenever he can. Linus got bored by the fact that there wasn't  a proper dive-log program natively for Linux and decided to write one by himself. This is how Subsurface was 'born'. Right now, the program is under development and from version 1.1 it is already very usable for divers with supported dive-computers.
  25
  26 2. Complete?
  27
  28 Before you are going to read information from your divecomputer to Subsurface, you need some preparation. Do you have the following:
  29
  30         1. Your Divecomputer - Compatible with libdivecomputer (see list in Appendix A)
  31         2. Communication interface - Cable to connect your divecomputer to your PC/Laptop/Netbook
  32         3. Working installation of libdivecomputer (see the build manual how to do this)
  33         4. Working installation of Subsurface
  34         5. If needed, the manual of your divecomputer
  35
  36 3. Start using the program:
  37
  38 When you start the program for the first time, it shows no information at all. This is because the program does not automatically load the already available dive-log files.
  39
  40 There is a menu, containing 'File', 'Log', 'Filter' and Help.
  41
  42 The screen is devided in 3 area's:
  43
  44         Area with 3 tabs: Dive Notes, Equipment, Info & Stats
  45         Area next to the 3 tabs, which will contain the diagrams
  46         Area with the dives, which can be sorted by number, date, etc.
  47
  48 The first thing you should do, is setting the preferences you want. By using menu 'File - Preferences' you will be presented a popup with the 'Units'. You are free to choose what is your preference, with other words, use Metric or Imperial.
  49
  50 You can set the following options:
  51         Depth:          Your diving depth in Meters or Feet
  52         Pressure:       The pressure of your tank(s) in Bar/Ato or PSI (Pressure Square Inch)
  53         Volume:         The volume of your tank(s) in Liter or CuFt (Cubic Feet) (At sea-level pressure)
  54         Temperature:    The temperature of the water in Celcius or Fahrenheit
  55
  56 In the main screen, you did see in Area 3, some information. In the Columns options, you can enable/disable options you  would like to show there:
  57         Show Temp:      Shows the temperature of your dive
  58         Show Cyl:       Shows the cylinder(s) of your dive
  59         Show O2%:       Shows the 02% of your dive
  60         Show SAC:       Shows the SAC of your dive (Surface Air Consumption)
  61         Show OTU:       Shows the OTU of your dive
  62
  63 And, you can change the font usage of the program.
  64
  65 I will give an example here:
  66
  67 I am a diver in The Netherlands, using the Metric System. Therefor, I go to the menu File, choose Preferences here. In the Units section, I use the folowing:
  68
  69         Depth:          Meter
  70         Pressure:       Bar
  71         Volume:         Liter
  72         Temperature:    Celcius
  73
  74 I would like to see the:
  75                         Temperature
  76                         Show Cyl
  77                         Show O2%
  78                         Show SAC
  79
  80 I don't know yet what the OTU is, because I am a beginner. So I leave this one not enabled.
  81
  82 So, now I am ready to use the program.
  83
  84 4. Reading information from your divecomputer
  85
  86 Before you start fiddeling around with your divecomputer, note that most divecomputers consume more power when they are in the PC-Communication mode. This could drain your battery. Therefor, ensure yourself that you prepaired the installation as mentioned in the build manual and that your divecomputer is compatible!
  87