]> git.tdb.fi Git - ext/subsurface.git/blobdiff - Documentation/user-manual.txt
Make icon file name OS helper function
[ext/subsurface.git] / Documentation / user-manual.txt
index bb86e73f61d04f87e07ec76d58ca03a06d509aa7..b9379e6368bcfdd3c37a0cfd1c4e002f72887773 100644 (file)
@@ -2,13 +2,13 @@ Subsurface 1.2
 
 User Manual
 
 
 User Manual
 
-Version 0.0.6
+Version 0.0.7
 
 Autor documentation: Jacco van Koll <jko@haringstad.com>
 
 Scope of this document is the usage of the program.
 Please read the build manual for instructions how to build the
 
 Autor documentation: Jacco van Koll <jko@haringstad.com>
 
 Scope of this document is the usage of the program.
 Please read the build manual for instructions how to build the
-software and (if needed) it´s dependencies.
+software and (if needed) its dependencies.
 
 Audience: Fun Divers, Tec Divers, Professional Divers
 
 
 Audience: Fun Divers, Tec Divers, Professional Divers
 
@@ -50,7 +50,7 @@ The screen is devided in 3 area's:
        Area with the dives (usually called dive list), which can be sorted by number, date, etc.
 
 
        Area with the dives (usually called dive list), which can be sorted by number, date, etc.
 
 
-4. Import new dives
+4. Import new dives from your divecomputer
 
 Before you start fiddeling around with your divecomputer, note that
 there are divecomputers that consume more power when they are in the
 
 Before you start fiddeling around with your divecomputer, note that
 there are divecomputers that consume more power when they are in the
@@ -278,7 +278,7 @@ Clicking OK on the dialog stores these settings.
 11. How to find the Device Name
 
 When you connect your divecomputer by using an USB connector, most of the
 11. How to find the Device Name
 
 When you connect your divecomputer by using an USB connector, most of the
-time, the default of ´/dev/ttyUSB0' should work. But if you have other
+time, the default of '/dev/ttyUSB0' should work. But if you have other
 Serial to USB devices, this can be different because '/dev/ttyUSB0' is
 already in use.
 
 Serial to USB devices, this can be different because '/dev/ttyUSB0' is
 already in use.
 
@@ -320,7 +320,7 @@ Maybe you have been using JDivelog and you have a lot of dives logged in
 this program. You don't have to type all information by hand into
 Subsurface, because you can import your divelogs from JDivelog.
 
 this program. You don't have to type all information by hand into
 Subsurface, because you can import your divelogs from JDivelog.
 
-JDivelog stores it's information into files with the extention of .jlb.
+JDivelog stores its information into files with the extention of .jlb.
 These .jlb contain all the information that has been stored, except your
 images in xml format.
 
 These .jlb contain all the information that has been stored, except your
 images in xml format.
 
@@ -457,6 +457,49 @@ And with the menu 'File - Save' you can save your dives into the
 Subsurface format.
 
 
 Subsurface format.
 
 
+14. The menu and sub-menus
+
+Within Subsurface, there are several menu and sub-menu options. All of
+those will be described here with their function.
+
+14.1 The file menu
+
+The file menu is used for the following menu options:
+
+       Open:           Open your saved Subsurface xml file(s)
+       Save:           Save your current divelogs or changes you made to your divelogs
+       Print:          Print your current divelog profiles and information about the dive
+       Import:         Import your dives from your divecomputer, JDivelogs or Suunto Divemanager
+       Preferences:    Set your preferences as described in chapter 10
+       Quit:           Quit the program
+
+14.2 The Log menu
+
+Within the Log menu, there are only 2 sub-items:
+
+       Renumber:       This option provides you with a popup. Within this
+                       popup you can choose what the first number of your dives should be
+                       for this set of dives.
+       View:           This is a submenu containing:
+               List:           Show only the list of dives you have made
+               Profile:        Show only the dive profile of the selected dive
+               Info:           Show only the 3 tab information screen
+               Three:          Show the 'default' 3 screen setup
+
+14.3 The Filter menu
+
+This menu gives you the choice to enable or disable Events for the
+selected divelog(s). At this time, you can enable or disable ascent.
+When you enable ascent for your dives, within the dive profile, a yellow
+marker with exclamation sign (!) will show on the points where you have
+ascented.
+
+14.4 The Help menu
+
+The Help menu shows only the About, which contains the version and author
+information and License button.
+
+
 Appendix A
 
 The use of libdivecomputer provides the support for divecomputers. Within
 Appendix A
 
 The use of libdivecomputer provides the support for divecomputers. Within
@@ -534,7 +577,7 @@ read SuuntoExportDir
 echo -n "Enter the name of your Suunto Divemanager export file: "
 read SuuntoExportFile
 
 echo -n "Enter the name of your Suunto Divemanager export file: "
 read SuuntoExportFile
 
-echo "You have entered: $SuuntoExportDir/$SuuntoExportFile¨
+echo "You have entered: $SuuntoExportDir/$SuuntoExportFile"
 
 cd $SuuntoExportDir
 
 
 cd $SuuntoExportDir