X-Git-Url: http://git.tdb.fi/?a=blobdiff_plain;ds=sidebyside;f=Documentation%2Fuser-manual.txt;h=aeee6a744c2a3337d9697c86123944b43774d015;hb=3d75c73f3677d98682b31766334ab02f124c76b9;hp=b46ee7c12e0a0ec84693435fc406af8e374ab2cf;hpb=1a83bf43b688dff5fa65afb751e7fdb65026e583;p=ext%2Fsubsurface.git diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt index b46ee7c..aeee6a7 100644 --- a/Documentation/user-manual.txt +++ b/Documentation/user-manual.txt @@ -1,16 +1,13 @@ Subsurface 1.2 User Manual ========================== -Jacco van Koll -:Author Initials: JvK +Jacco van_Koll +v0.0.7, January 2021 +:Author Initials: JKO :toc: :icons: :numbered: :website: http://subsurface.hohndel.org -Version 0.0.7 - -Autor documentation: Jacco van Koll - 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) its dependencies. @@ -18,8 +15,9 @@ software and (if needed) its dependencies. Audience: Fun Divers, Tec Divers, Professional Divers -Introduction ------------- +[[S_Introduction]] +Introduction: +------------- Subsurface was started because of a lack of viable dive log software on Linux. It turns out that the resulting software was easily ported @@ -30,18 +28,20 @@ already very usable for divers with supported dive-computers. In this manual the Suunto Viper will be used for all examples. +[[S_Requirements]] Requirements ------------ Before you are able to import information from your divecomputer into Subsurface, you need some preparation. Do you have the following: - 1. Your Divecomputer - Compatible with libdivecomputer (see list in Appendix A) + 1. Your Divecomputer - Compatible with libdivecomputer (see list in <>) 2. Communication interface - Cable to connect your divecomputer to your PC/Laptop/Netbook 3. Working installation of Subsurface 4. If needed, the manual of your divecomputer +[[S_StartUsing]] Start using the program ----------------------- @@ -58,6 +58,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. +[[S_ImportNewDives]] Import new dives from your divecomputer --------------------------------------- @@ -104,6 +105,7 @@ Now it is time to hook up your divecomputer to your Linux system: could take some time. Please be patient. +[[S_ViewingLogs]] Viewing and completing your logs -------------------------------- @@ -114,27 +116,19 @@ An example: On Sunday Oct 23, 2011 you made a dive. In the log line of this dive, you see the following information: - - #:: - 12 Dive number - Date:: - Sun, Oct 23, 2011 10:50 Date and time of your dive - *:: - Your rating (none at this time) - m:: - 12.8 Your maximum depth in meters - min:: - 31:20 Your dive-time in minutes and seconds - Deg. C:: - 13.0 Lowest water temperature during your dive - Cyl:: - Your used cylinder (none at this time) - O2%:: - air What type of mixture - SAC:: - SAC (none at this time) - Location:: - Where you performed your dive (empty) +[width="70%",cols="<5%,10%,<20%,<65%",grid="none",frame="none",style="monospaced"] +|=============================================================================== +|| # | 12 | Dive number +|| Date | Sun, Oct 23, 2011 10:50 | Date and time of your dive +|| * | | Your rating (none at this time) +|| m | 12.8 | Your maximum depth in meters +|| min | 31:20 | Your dive-time in minutes and seconds +|| Deg. C | 13.0 | Lowest water temperature during your dive +|| Cyl | | Your used cylinder (none at this time) +|| O2% | air | What type of mixture +|| SAC | | SAC (none at this time) +|| Location | | Where you performed your dive (empty) +|=============================================================================== As you can see, some information is already there because it is retrieved from your divecomputer. Some information is waiting for @@ -142,6 +136,7 @@ you to be added. By double clicking on this dive, you can view and complete the log. +[[S_EditDiveInfo]] Edit the dive info ------------------ @@ -149,34 +144,34 @@ When you double click on the dive log line, the editor window opens. Now you can add information that is missing. Let start with completing the example: -You double clicked on dive #12, as described in 5. Viewing and -completing your logs. The Dive Info window pops up and you will see +You double clicked on dive #12, as described in <>. The Dive Info window pops up and you will see the following: - - - Location: An input where you can enter your new location, or you can choose with the pull-down previous locations - - Dive Master: An input where you can enter the name of your Dive Master, or you can choose with the pull-down a previous name - - Buddy: An input where you can enter het name of you Buddy, or you can choose with the pull-down a previous name - - Rating: A pull-down where you can rate your dive. - - Notes: A free input where you can enter information about your dive. What you've seen, etc. +[horizontal] + *Location*:: An input where you can enter your new location, or you can choose with the pull-down previous locations + *Dive Master*:: An input where you can enter the name of your Dive Master, or you can choose with the pull-down a previous name + *Buddy*:: An input where you can enter het name of you Buddy, or you can choose with the pull-down a previous name + *Rating*:: A pull-down where you can rate your dive. + *Notes*:: A free input where you can enter information about your dive. What you've seen, etc. In this example we use the following information: - - - Location: Oostvoornse Meer - - Dive Master: S. de Vries - - Buddy: S. de Vries - - Rating: 3 stars - - Notes: First dive here. Good visibility. Did see the concrete poles, some crab and fish. Very nice and easy dive. - Made movie with 'headcam'. +[horizontal] + *Location*:: Oostvoornse Meer + *Dive Master*:: S. de Vries + *Buddy*:: S. de Vries + *Rating*:: 3 stars + *Notes*:: First dive here. Good visibility. Did see the concrete poles, some crab and fish. Very nice and easy dive. + + Made movie with headcam. Now don't press ok yet! - +[[S_EditEquipmentInfo]] Edit equipment info ------------------- -You also want to edit your Cylinder information. And in the previous -chapter, this was not edited. There is still another item to edit in -the Dive Info screen: +You also want to edit your Cylinder information. And in the +<>, this was not edited. There is +still another item to edit in the Dive Info screen: - Cylinder: A double-click fieldset. Here you can edit your Cylinder information @@ -184,7 +179,7 @@ So, when you double click on the cylinder info, you get another popup. This popup gives you the following: - Cylinder: Pull-down where you can choose your Cylinder, or add your own - - Size: The volume if not 'filled' + - Size: The volume if not `filled' - Pressure: The maximum pressure of this Cylinder - Optional: * Start Pressure: What was the pressure starting the dive @@ -206,7 +201,7 @@ Now tick the option for Start & End pressure Now your dive information for this dive is complete. You can now press ok in the Dive Info screen and view the results. - +[[S_AddingEquipment]] Adding equipment info --------------------- @@ -222,7 +217,7 @@ can add Cylinders. We are going to add an additional Cylinder: info, you add your cylinder information for the second Cylinder. Fill in all the information about this Cylinder and press OK. - +[[S_ViewInfoStats]] View info & Stats ----------------- @@ -255,7 +250,7 @@ The information contains: ** Min SAC: Lowest of Surface Air Consumption of all your dives ** Avg SAC: Average Surface Air Consuption of all your dives, calculated - +[[S_SettingUpPreferences]] Setting up preferences ---------------------- @@ -304,7 +299,7 @@ one not enabled. Clicking OK on the dialog stores these settings. - +[[S_HowFindDeviceName]] How to find the Device Name --------------------------- @@ -344,7 +339,7 @@ detected and is connected to 'ttyUSB3'. Now you use this information in the import settings as '/dev/ttyUSB3'. Your divecomputer interface is connected and you should be able to import your dives. - +[[S_ImportingDivesJDivelog]] Importing dives from JDivelog ----------------------------- @@ -357,9 +352,9 @@ These .jlb contain all the information that has been stored, except your images in xml format. By using the menu 'File - Import' you get the popup, like described in -chapter 4, Importing new dives. Within this popup there is the option -to import existing files which are already on your computer. To import -your JDivelog file(s) do the following: +<>, Importing new dives. Within this +popup there is the option to import existing files which are already +on your computer. To import your JDivelog file(s) do the following: - Open 'File - Import' on the menu - Use the file locator under XML file name @@ -368,7 +363,7 @@ your JDivelog file(s) do the following: - Click the OK button in the popup After a few moments, you see your existing logs in Subsurface. Now you can -edit your dives like explained in chapter 6. +edit your dives like explained in <>. Information that is imported from JDivelog into the location field: @@ -400,7 +395,7 @@ as there are no time zone issues (or other reasons that would cause the beginning time of the dives to be substantially different) subsurface will not create duplicate entries. - +[[S_ImportingDivesSuunto]] Importing dives from Suunto Divemanager 3.* ------------------------------------------- @@ -476,7 +471,7 @@ The example uses an USB storage: - The file is now transfered to /tmp Now the file is in /tmp, we can extract the xml files from it. You can do -this by hand, or use the example script in Appendix B. +this by hand, or use the example script in <>. To extract the xml files, we need to open a terminal and use the following commands: @@ -494,7 +489,7 @@ can import them with the command: And with the menu 'File - Save' you can save your dives into the Subsurface format. - +[[S_Menu]] The menu and sub-menus ---------------------- @@ -510,7 +505,7 @@ The file menu is used for the following menu options: - 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 + - Preferences:: Set your preferences as described in <> - Quit:: Quit the program The Log menu @@ -543,8 +538,9 @@ The Help menu shows only the About, which contains the version and author information and License button. -Appendix A ----------- +[[AppendixA]] +Appendix A: Supported Dive Computers +------------------------------------ The use of libdivecomputer provides the support for divecomputers. Within the list of computers in the 'File - import' menu, you will see a listing @@ -615,8 +611,9 @@ your users manual to check if your computer will be supported. * OSTC computers are listed in the pull-down menu as OSTC. All 3 types are supported. -Appendix B ----------- +[[AppendixB]] +Appendix B: Suunto Export Unpacking Script +------------------------------------------ #!/bin/bash #