Documentation/user-manual.txt

   1 Subsurface 1.2
   2
   3 User Manual
   4
   5 Version 0.0.1
   6
   7 Autor documentation: Jacco van Koll
   8
   9
  10 Scope of this document is the usage of the program.
  11 Please read the build manual for instructions how to build the
  12 software and (if needed) it´s dependencies.
  13
  14
  15 Audience: Fun Divers, Tec Divers, Professional Divers
  16
  17
  18 1. Introduction:
  19
  20 Subsurface was started because of a lack of viable dive log software
  21 on Linux. It turns out that the resulting software was easily ported
  22 to Windows and Mac, but it clearly is a native Linux program first.
  23 Right now, the program is under development and from version 1.1 it is
  24 already very usable for divers with supported dive-computers.
  25
  26
  27 2. Requirements
  28
  29 Before you are able to import information from your divecomputer into
  30 Subsurface, you need some preparation. Do you have the following:
  31
  32         1. Your Divecomputer - Compatible with libdivecomputer (see list in Appendix A)
  33         2. Communication interface - Cable to connect your divecomputer to your PC/Laptop/Netbook
  34         3. Working installation of Subsurface
  35         4. If needed, the manual of your divecomputer
  36
  37
  38 3. Start using the program:
  39
  40 When you start the program for the first time, it shows no information
  41 at all. This is because the program does not automatically load the
  42 already available dive-log files.
  43
  44 There is a menu, containing 'File', 'Log', 'Filter' and Help.
  45
  46 The screen is devided in 3 area's:
  47
  48         Area with 3 tabs: Dive Notes, Equipment, Info & Stats
  49         Area next to the 3 tabs, which will contain the dive profile
  50         Area with the dives (usually called dive list), which can be sorted by number, date, etc.
  51
  52
  53 4. Import new dives
  54
  55 Before you start fiddeling around with your divecomputer, note that
  56 many divecomputers (for example, all the Suunto computers) consume
  57 more power when they are in the PC-Communication mode. This could
  58 drain your battery. Therefor, ensure yourself that you prepared the
  59 installation as mentioned in the build manual and that your
  60 divecomputer is compatible!
  61
  62 ...
  63
  64
  65 5. Load existing dive log
  66
  67 ...
  68
  69
  70 6. Edit the dive info
  71
  72
  73
  74 7. Edit equipment info
  75
  76
  77 8. Setting up preferences
  78
  79 By using menu 'File - Preferences' you will be presented a popup with
  80 the 'Units'. You are free to choose what is your preference, with
  81 other words, use Metric or Imperial.
  82
  83 You can set the following options:
  84         Depth:          Your diving depth in Meters or Feet
  85         Pressure:       The pressure of your tank(s) in Bar/Ato or PSI (Pressure Square Inch)
  86         Volume:         The volume of your tank(s) in Liter or CuFt (Cubic Feet) (At sea-level pressure)
  87         Temperature:    The temperature of the water in Celcius or Fahrenheit
  88
  89 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:
  90         Show Temp:      Shows the temperature of your dive
  91         Show Cyl:       Shows the cylinder(s) of your dive
  92         Show O2%:       Shows the 02% of your dive
  93         Show SAC:       Shows the SAC of your dive (Surface Air Consumption)
  94         Show OTU:       Shows the OTU of your dive (Oxygen Toxicity Units)
  95
  96 And, you can change the font usage of the program.
  97
  98 I will give an example here:
  99
 100 I am a diver in The Netherlands, using the Metric System. Therefor, I
 101 go to the menu File, choose Preferences here. In the Units section, I
 102 use the folowing:
 103
 104         Depth:          Meter
 105         Pressure:       Bar
 106         Volume:         Liter
 107         Temperature:    Celcius
 108
 109 I would like to see the:
 110                         Temperature
 111                         Show Cyl
 112                         Show O2%
 113                         Show SAC
 114
 115 As a beginning diver, I don't need to track my OTUs. So I leave this
 116 one not enabled.
 117
 118 Clicking OK on the dialog stores these settings.