mifr/subsurface
1
0
Fork 0
mirror of https://github.com/subsurface/subsurface.git synced 2025-02-19 22:16:15 +00:00
Code Issues Projects Releases Packages Wiki Activity

First try at converting user-manual to AsciiDoc

Browse source 
You can do "make doc" in the main directory to create the html version,
and if you want to play around with it, do "make show" in the
Documentation subdirectory to start firefox on the end result.

It's by no means perfect, but it gives somewhat reasonable results, and
this is enough initial work for people to play around with, I think.

NOTE! You need "asciidoc" installed to do this: it's a python program,
so it should be pretty easy even on non-Linux platforms.  And on Linux,
most distributions package it, so you just have to do something like

	yum install asciidoc

to get it (replace with apt-get/zypper/whatever).

Asciidoc can generate other output too (man-pages, LaTeX, etc), maybe
people want to play with that part too.

Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
This commit is contained in:
Linus Torvalds 2012-01-01 15:12:28 -08:00
parent 1d51c77729
commit 1a83bf43b6
3 changed files with 282 additions and 216 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
Documentation/Makefile Normal file
View file

@ -0,0 +1,10 @@
ASCIIDOC=asciidoc
BROWSER=firefox
doc: user-manual.html
show: user-manual.html
$(BROWSER) user-manual.html
user-manual.html: user-manual.txt
$(ASCIIDOC) user-manual.txt

465
Documentation/user-manual.txt
View file

@ -1,6 +1,11 @@
Subsurface 1.2 Subsurface 1.2 User Manual
==========================
User Manual Jacco van Koll <jko@haringstad.com>
:Author Initials: JvK
:toc:
:icons:
:numbered:
:website: http://subsurface.hohndel.org
Version 0.0.7 Version 0.0.7
@ -13,7 +18,8 @@ software and (if needed) its dependencies.
Audience: Fun Divers, Tec Divers, Professional Divers Audience: Fun Divers, Tec Divers, Professional Divers
1. Introduction: Introduction
------------
Subsurface was started because of a lack of viable dive log software Subsurface was started because of a lack of viable dive log software
on Linux. It turns out that the resulting software was easily ported on Linux. It turns out that the resulting software was easily ported
@ -24,7 +30,8 @@ already very usable for divers with supported dive-computers.
In this manual the Suunto Viper will be used for all examples. In this manual the Suunto Viper will be used for all examples.
2. Requirements Requirements
------------
Before you are able to import information from your divecomputer into Before you are able to import information from your divecomputer into
Subsurface, you need some preparation. Do you have the following: Subsurface, you need some preparation. Do you have the following:
@ -35,7 +42,8 @@ Subsurface, you need some preparation. Do you have the following:
4. If needed, the manual of your divecomputer 4. If needed, the manual of your divecomputer
3. Start using the program: Start using the program
-----------------------
When you start the program for the first time, it shows no information 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 at all. This is because the program does not automatically load the
@ -45,12 +53,13 @@ There is a menu, containing 'File', 'Log', 'Filter' and Help.
The screen is devided in 3 area's: The screen is devided in 3 area's:
Area with 3 tabs: Dive Notes, Equipment, Info & Stats - Area with 3 tabs: Dive Notes, Equipment, Info & Stats
Area next to the 3 tabs, which will contain the dive profile - Area next to the 3 tabs which will contain the dive profile
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 from your divecomputer Import new dives from your divecomputer
---------------------------------------
Before you start fiddeling around with your divecomputer, note that Before you start fiddeling around with your divecomputer, note that
there are divecomputers that consume more power when they are in the there are divecomputers that consume more power when they are in the
@ -62,40 +71,41 @@ be recharged when connected to the USB port.
Now it is time to hook up your divecomputer to your Linux system: Now it is time to hook up your divecomputer to your Linux system:
Make sure that your OS has the required drivers installed - Make sure that your OS has the required drivers installed
On Linux this means you need to have the correct kernel * On Linux this means you need to have the correct kernel
module loaded. Most distributions will do this automatically module loaded. Most distributions will do this automatically
for you. for you.
On Windows, the OS should offer to download the correct * On Windows, the OS should offer to download the correct
driver when you connect to the USB port. driver when you connect to the USB port.
On a Mac you at times have to manually hunt for the correct * On a Mac you at times have to manually hunt for the correct
driver. For example the correct driver for the Mares Puck driver. For example the correct driver for the Mares Puck
devices can be found as Mac_OSX_VCP_Driver.zip at devices can be found as Mac_OSX_VCP_Driver.zip at
http://www.silabs.com/support/pages/support.aspx?ProductFamily=USB+Bridges http://www.silabs.com/support/pages/support.aspx?ProductFamily=USB+Bridges
Connect your interface cable to a free USB port - Connect your interface cable to a free USB port
Put your divecomputer into PC Communication mode. (For Suunto Viper, press Mode - 1 Memory - 3 TR-PC) - Put your divecomputer into PC Communication mode. (For Suunto Viper, press Mode - 1 Memory - 3 TR-PC)
(You should consult the manual of your specific divecomputer for your brand and type) (You should consult the manual of your specific divecomputer for your brand and type)
Go in Subsurface to 'File - Import' - Go in Subsurface to 'File - Import'
Within the popup, under Dive computer, choose your brand and type. Here we choose Suunto Vyper. * Within the popup, under Dive computer, choose your brand and type. Here we choose Suunto Vyper.
Change the devicename under which your interface is connected. * Change the devicename under which your interface is connected.
On Linux, default is /dev/ttyUSB0 ** On Linux, default is /dev/ttyUSB0
On Windows, default is COM3 ** On Windows, default is COM3
On Mac, default is ... specific to the dive computer ** On Mac, default is ... specific to the dive computer
Click the 'OK' button. * Click the 'OK' button.
Now watch how your data is retrieved from your divecomputer! - Now watch how your data is retrieved from your divecomputer!
Depending on your type of computer and/or number of dives, this Depending on your type of computer and/or number of dives, this
could take some time. Please be patient. could take some time. Please be patient.
5. Viewing and completing your logs Viewing and completing your logs
--------------------------------
When all data from your divecomputer is transferred, you will see a When all data from your divecomputer is transferred, you will see a
listing of your dives in Area 3. listing of your dives in Area 3.
@ -105,24 +115,35 @@ An example:
On Sunday Oct 23, 2011 you made a dive. On Sunday Oct 23, 2011 you made a dive.
In the log line of this dive, you see the following information: 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 12 Dive number
*: Your rating (none at this time) Date::
m: 12.8 Your maximum depth in meters Sun, Oct 23, 2011 10:50 Date and time of your dive
min: 31:20 Your dive-time in minutes and seconds *::
Deg. C: 13.0 Lowest water temperature during your dive Your rating (none at this time)
Cyl: Your used cylinder (none at this time) m::
O2%: air What type of mixture 12.8 Your maximum depth in meters
SAC: SAC (none at this time) min::
Location: Where you performed your dive (empty) 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 As you can see, some information is already there because it is
retrieved from your divecomputer. Some information is waiting for retrieved from your divecomputer. Some information is waiting for
you to be added. By double clicking on this dive, you can view and you to be added. By double clicking on this dive, you can view and
complete the log. complete the log.
6. Edit the dive info Edit the dive info
------------------
When you double click on the dive log line, the editor window When you double click on the dive log line, the editor window
opens. Now you can add information that is missing. Let start with opens. Now you can add information that is missing. Let start with
@ -132,71 +153,78 @@ 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 completing your logs. The Dive Info window pops up and you will see
the following: the following:
Location: An input where you can enter your new location, or you can choose with the pull-down previous locations - 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 - 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 - 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. - 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. - 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: In this example we use the following information:
Location: Oostvoornse Meer - Location: Oostvoornse Meer
Dive Master: S. de Vries - Dive Master: S. de Vries
Buddy: S. de Vries - Buddy: S. de Vries
Rating: 3 stars - Rating: 3 stars
Notes: First dive here. Good visibility. Did see the concrete poles, some crab and fish. Very nice and easy dive. - Notes: First dive here. Good visibility. Did see the concrete poles, some crab and fish. Very nice and easy dive.
Made movie with 'headcam'. Made movie with 'headcam'.
Now don't press ok yet! Now don't press ok yet!
7. Edit equipment info Edit equipment info
-------------------
You also want to edit your Cylinder information. And in the previous 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 chapter, this was not edited. There is still another item to edit in
the Dive Info screen: the Dive Info screen:
Cylinder: A double-click fieldset. Here you can edit your Cylinder information - Cylinder: A double-click fieldset. Here you can edit your Cylinder information
So, when you double click on the cylinder info, you get another So, when you double click on the cylinder info, you get another
popup. This popup gives you the following: popup. This popup gives you the following:
Cylinder: Pull-down where you can choose your Cylinder, or add your own - 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 - Pressure: The maximum pressure of this Cylinder
Optional: - Optional:
Start Pressure: What was the pressure starting the dive * Start Pressure: What was the pressure starting the dive
End Pressure: What was the pressure ending the dive * End Pressure: What was the pressure ending the dive
Nitrox: What was the percentage of blend * Nitrox: What was the percentage of blend
Now we are going to enter the data: Now we are going to enter the data:
Cylinder: 15.0 l - Cylinder: 15.0 l
Size: 15.0 - Size: 15.0
Pressure: 220 - Pressure: 220
Now tick the option for Start & End pressure Now tick the option for Start & End pressure
Start Pressure: 180 - Start Pressure: 180
End Pressure: 60 - End Pressure: 60
Press Ok - Press Ok
Now your dive information for this dive is complete. You can now press Now your dive information for this dive is complete. You can now press
ok in the Dive Info screen and view the results. ok in the Dive Info screen and view the results.
8. Adding equipment info Adding equipment info
---------------------
In Area with the 3 tabs there is the tab Equipment. With this tab, you In Area with the 3 tabs there is the tab Equipment. With this tab, you
can add Cylinders. We are going to add an additional Cylinder: can add Cylinders. We are going to add an additional Cylinder:
In the main screen, click on the Equipment tab. This shows your Cylinder you added in 7. - In the main screen, click on the Equipment tab. This shows your
Now press the Add button and the Cylinder popup comes back. Cylinder you added in 7.
Just like you added your Cylinder information in 7. Edit equipment info, you add your cylinder
information for the second Cylinder. Fill in all the information about this Cylinder and press OK. - Now press the Add button and the Cylinder popup comes back.
- Just like you added your Cylinder information in 7. Edit equipment
info, you add your cylinder information for the second Cylinder.
Fill in all the information about this Cylinder and press OK.
9. View info & Stats View info & Stats
-----------------
After adding all the information, you can use the tab Info & After adding all the information, you can use the tab Info &
Stats. This tab will provide you with all the (statistical and Stats. This tab will provide you with all the (statistical and
@ -204,31 +232,32 @@ calculated) information regarding your dive.
The information contains: The information contains:
Dive Info: - Dive Info:
Date: Date and time of your dive ** Date: Date and time of your dive
Dive Time: Duration of your dive ** Dive Time: Duration of your dive
Surf Intv: Interval between previous dive and this dive ** Surf Intv: Interval between previous dive and this dive
Max Depth: Maximum depth of this dive ** Max Depth: Maximum depth of this dive
Avg Depth: The average depth of this dive ** Avg Depth: The average depth of this dive
Water Temp: Lowest temperature of the water ** Water Temp: Lowest temperature of the water
SAC: The amount of Surface Air Consumption liters per minute ** SAC: The amount of Surface Air Consumption liters per minute
OTU: The Oxygen Toxicity Units of this dive ** OTU: The Oxygen Toxicity Units of this dive
O2/He: Amount of Oxygen/Helium ** O2/He: Amount of Oxygen/Helium
Gas Used: The total volume of gas used during this dive ** Gas Used: The total volume of gas used during this dive
Statistics: - Statistics:
Total time: Total time of all your dives together, calculated ** Total time: Total time of all your dives together, calculated
Avg Time: The average divetime of your dives, calculated ** Avg Time: The average divetime of your dives, calculated
Max Depth: The maximum depth of all your dives ** Max Depth: The maximum depth of all your dives
Avg Depth: The average depth of all your dives, calculated ** Avg Depth: The average depth of all your dives, calculated
Max SAC: Highest of Surface Air Consumption of all your dives ** Max SAC: Highest of Surface Air Consumption of all your dives
Min SAC: Lowest of Surface Air Consumption of all your dives ** Min SAC: Lowest of Surface Air Consumption of all your dives
Avg SAC: Average Surface Air Consuption of all your dives, calculated ** Avg SAC: Average Surface Air Consuption of all your dives, calculated
10. Setting up preferences Setting up preferences
----------------------
Subsurface has the ability to modify the preferences you want. By Subsurface has the ability to modify the preferences you want. By
using menu 'File - Preferences' you will be presented a popup with the using menu 'File - Preferences' you will be presented a popup with the
@ -236,19 +265,19 @@ using menu 'File - Preferences' you will be presented a popup with the
words, use Metric or Imperial. words, use Metric or Imperial.
You can set the following options: You can set the following options:
Depth: Your diving depth in Meters or Feet - Depth: Your diving depth in Meters or Feet
Pressure: The pressure of your tank(s) in Bar/Ato or PSI (Pressure Square Inch) - Pressure: The pressure of your tank(s) in Bar/Ato or PSI (Pressure Square Inch)
Volume: The volume of your tank(s) in Liter or CuFt (Cubic Feet) (At sea-level pressure) - Volume: The volume of your tank(s) in Liter or CuFt (Cubic Feet) (At sea-level pressure)
Temperature: The temperature of the water in Celcius or Fahrenheit - Temperature: The temperature of the water in Celcius or Fahrenheit
In the main screen, you did see in Area 3, some information. In the 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 Columns options, you can enable/disable options you would like to show
there: there:
Show Temp: Shows the temperature of your dive - Show Temp: Shows the temperature of your dive
Show Cyl: Shows the cylinder(s) of your dive - Show Cyl: Shows the cylinder(s) of your dive
Show O2%: Shows the O2% of your dive - Show O2%: Shows the O2% of your dive
Show SAC: Shows the SAC of your dive (Surface Air Consumption) - Show SAC: Shows the SAC of your dive (Surface Air Consumption)
Show OTU: Shows the OTU of your dive (Oxygen Toxicity Units) - Show OTU: Shows the OTU of your dive (Oxygen Toxicity Units)
And, you can change the font usage of the program. And, you can change the font usage of the program.
@ -258,16 +287,17 @@ 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 go to the menu File, choose Preferences here. In the Units section, I
use the folowing: use the folowing:
Depth: Meter - Depth: Meter
Pressure: Bar - Pressure: Bar
Volume: Liter - Volume: Liter
Temperature: Celcius - Temperature: Celcius
I would like to see the: I would like to see the:
Temperature
Show Cyl - Temperature
Show O2% - Show Cyl
Show SAC - Show O2%
- Show SAC
As a beginning diver, I don't need to track my OTUs. So I leave this As a beginning diver, I don't need to track my OTUs. So I leave this
one not enabled. one not enabled.
@ -275,7 +305,8 @@ one not enabled.
Clicking OK on the dialog stores these settings. Clicking OK on the dialog stores these settings.
11. How to find the Device Name How to find the Device Name
---------------------------
When you connect your divecomputer by using an USB connector, most of the 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
@ -284,11 +315,11 @@ already in use.
One of the ways to find out what your dive name is: One of the ways to find out what your dive name is:
Disconnect your usb cable of your dive computer - Disconnect your usb cable of your dive computer
Open a terminal - Open a terminal
Type the command: 'dmesg' and press enter - Type the command: 'dmesg' and press enter
Plug in your usb cable of your divecomputer - Plug in your usb cable of your divecomputer
Type the command: 'dmesg' and press enter - Type the command: 'dmesg' and press enter
Within your terminal you should see a message similair to this one: Within your terminal you should see a message similair to this one:
@ -314,7 +345,8 @@ the import settings as '/dev/ttyUSB3'. Your divecomputer interface is
connected and you should be able to import your dives. connected and you should be able to import your dives.
12. Importing dives from JDivelog Importing dives from JDivelog
-----------------------------
Maybe you have been using JDivelog and you have a lot of dives logged in 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 this program. You don't have to type all information by hand into
@ -329,26 +361,26 @@ chapter 4, Importing new dives. Within this popup there is the option
to import existing files which are already on your computer. To import to import existing files which are already on your computer. To import
your JDivelog file(s) do the following: your JDivelog file(s) do the following:
Open 'File - Import' on the menu - Open 'File - Import' on the menu
Use the file locator under XML file name - Use the file locator under XML file name
Browse your directories to the location where your *.jlb file is - Browse your directories to the location where your *.jlb file is
Select your existing *.jlb file and click 'open' - Select your existing *.jlb file and click 'open'
Click the OK button in the popup - Click the OK button in the popup
After a few moments, you see your existing logs in Subsurface. Now you can 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 chapter 6.
Information that is imported from JDivelog into the location field: Information that is imported from JDivelog into the location field:
Extended dive location information - Extended dive location information
Information that is merged into the location or notes field: Information that is merged into the location or notes field:
Used amount of weight - Used amount of weight
Used type of suit - Used type of suit
Used type of gloves - Used type of gloves
Type of dive - Type of dive
Dive activity - Dive activity
Alternatively, you can start subsurface with the --import comand line Alternatively, you can start subsurface with the --import comand line
which will have the same effect: which will have the same effect:
@ -369,50 +401,56 @@ beginning time of the dives to be substantially different) subsurface
will not create duplicate entries. will not create duplicate entries.
13. Importing dives from Suunto Divemanager 3.* Importing dives from Suunto Divemanager 3.*
-------------------------------------------
Before you can start importing dives from Suunto Divemanager, you first Before you can start importing dives from Suunto Divemanager, you first
have to export the dives you want to import. Subsurface does not import have to export the dives you want to import. Subsurface does not import
directly from the Suunto Divemanager log files. The following procedures directly from the Suunto Divemanager log files. The following procedures
unpacking instructions for Linux and Windows. unpacking instructions for Linux and Windows.
13.1 Export from Suunto Divemanager: Export from Suunto Divemanager
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Start Suunto Divemanager and login with the name containing the logs - Start Suunto Divemanager and login with the name containing the logs
Do not start the import wizard to import dives from your computer. - Do not start the import wizard to import dives from your computer.
In the navigation tree on the left side of the program-window, select your dives. - In the navigation tree on the left side of the program-window, select your dives.
Within the list of dives, select the dives you would like to import later: - Within the list of dives, select the dives you would like to import later:
To select certain dives: hold ctrl and point & click the dive * To select certain dives: hold ctrl and point & click the dive
To select all dives: Select the first dive, hold down shift and select the last dive * To select all dives: Select the first dive, hold down shift and select the last dive
With the dives marked, use the program menu 'File - Export' - With the dives marked, use the program menu 'File - Export'
The export popup will show - The export popup will show
Within this popup, there is one field called Export Path. - Within this popup, there is one field called Export Path.
Click the button browse next to the field Export Path * Click the button browse next to the field Export Path
A file-manager like window pops up ** A file-manager like window pops up
Navigate to the directory where you want to store the Divelog.SDE file ** Navigate to the directory where you want to store the Divelog.SDE file
Optional change the name of the file you want to save ** Optional change the name of the file you want to save
Click 'Save' ** Click 'Save'
You are back in the Export popup. Press the button 'Export' * You are back in the Export popup. Press the button 'Export'
Your dives are now exported to the file Divelogs.SDE. - Your dives are now exported to the file Divelogs.SDE.
13.2 Unpacking the Divelogs.SDE on Windows Unpacking the Divelogs.SDE on Windows
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Renaming your file to a .zip: Renaming your file to a .zip:
Use the filemanager (explorer) and navigate to your Divelogs.SDE file - Use the filemanager (explorer) and navigate to your Divelogs.SDE file
Right click on the Divelogs.SDE file and choose 'Rename' - Right click on the Divelogs.SDE file and choose 'Rename'
Change the name into Divelogs.SDE.zip * Change the name into Divelogs.SDE.zip
Press enter when done. A warning popup shows: * Press enter when done. A warning popup shows:
The file could be unusable when changing the extension. Are you sure: The file could be unusable when changing the extension. Are you sure:
Press OK. Press OK.
Your filemanager will show now the filename Divelogs.SDE.zip
* Your filemanager will show now the filename Divelogs.SDE.zip
When you double click your Divelogs.SDE.zip file, your preferred archiving When you double click your Divelogs.SDE.zip file, your preferred archiving
tool will start and show you the list of xml files that are in the zip tool will start and show you the list of xml files that are in the zip
archive. Select all the xml files and extract them to a place where you archive. Select all the xml files and extract them to a place where you
can find them later in the process. can find them later in the process.
13.3 Unpacking the Divelogs.SDE on Linux Unpacking the Divelogs.SDE on Linux
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The assumption is that you have exported your Divelogs.SDE on a Windows The assumption is that you have exported your Divelogs.SDE on a Windows
system. You have to transfer the file to a location where you can read it system. You have to transfer the file to a location where you can read it
@ -420,22 +458,22 @@ from within your Linux environment. You can use file-tranfer, shared
storage or an USB storage device to do this. storage or an USB storage device to do this.
The example uses an USB storage: The example uses an USB storage:
Insert your USB storage into your Windows computer - Insert your USB storage into your Windows computer
Use the filemanager (explorer) to navigate to the location where your Divelogs.SDE file is located - Use the filemanager (explorer) to navigate to the location where your Divelogs.SDE file is located
Copy the file to your USB storage: - Copy the file to your USB storage:
Select the file by 1 click * Select the file by 1 click
Press Ctrl+c * Press Ctrl+c
Navigate to your USB Storage * Navigate to your USB Storage
Press Ctrl+v * Press Ctrl+v
Disconnect your USB storage by right clicking your USB storage in the explorer and choose Eject - Disconnect your USB storage by right clicking your USB storage in the explorer and choose Eject
Insert your USB storage into your Linux computer - Insert your USB storage into your Linux computer
Use your favourite filemanager to navigate to your USB storage - Use your favourite filemanager to navigate to your USB storage
Copy the file to /tmp by: - Copy the file to /tmp by:
Right click on the file * Right click on the file
select copy * select copy
navigate to /tmp * navigate to /tmp
press Ctrl+v or use the menu 'Edit - Paste' * press Ctrl+v or use the menu 'Edit - Paste'
The file is now transfered to /tmp - The file is now transfered to /tmp
Now the file is in /tmp, we can extract the xml files from it. You can do 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 Appendix B.
@ -457,36 +495,40 @@ And with the menu 'File - Save' you can save your dives into the
Subsurface format. Subsurface format.
14. The menu and sub-menus The menu and sub-menus
----------------------
Within Subsurface, there are several menu and sub-menu options. All of Within Subsurface, there are several menu and sub-menu options. All of
those will be described here with their function. those will be described here with their function.
14.1 The file menu The file menu
~~~~~~~~~~~~~
The file menu is used for the following menu options: The file menu is used for the following menu options:
Open: Open your saved Subsurface xml file(s) - Open:: Open your saved Subsurface xml file(s)
Save: Save your current divelogs or changes you made to your divelogs - Save:: Save your current divelogs or changes you made to your divelogs
Print: Print your current divelog profiles and information about the dive - Print:: Print your current divelog profiles and information about the dive
Import: Import your dives from your divecomputer, JDivelogs or Suunto Divemanager - 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 chapter 10
Quit: Quit the program - Quit:: Quit the program
14.2 The Log menu The Log menu
~~~~~~~~~~~~
Within the Log menu, there are only 2 sub-items: Within the Log menu, there are only 2 sub-items:
Renumber: This option provides you with a popup. Within this - Renumber:: This option provides you with a popup. Within this
popup you can choose what the first number of your dives should be popup you can choose what the first number of your dives should be
for this set of dives. for this set of dives.
View: This is a submenu containing: - View:: This is a submenu containing:
List: Show only the list of dives you have made * List:: Show only the list of dives you have made
Profile: Show only the dive profile of the selected dive * Profile:: Show only the dive profile of the selected dive
Info: Show only the 3 tab information screen * Info:: Show only the 3 tab information screen
Three: Show the 'default' 3 screen setup * Three:: Show the 'default' 3 screen setup
14.3 The Filter menu The Filter menu
~~~~~~~~~~~~~~~
This menu gives you the choice to enable or disable Events for the 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. selected divelog(s). At this time, you can enable or disable ascent.
@ -494,41 +536,49 @@ 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 marker with exclamation sign (!) will show on the points where you have
ascented. ascented.
14.4 The Help menu The Help menu
~~~~~~~~~~~~~
The Help menu shows only the About, which contains the version and author The Help menu shows only the About, which contains the version and author
information and License button. information and License button.
Appendix A Appendix A
----------
The use of libdivecomputer provides the support for divecomputers. Within The use of libdivecomputer provides the support for divecomputers. Within
the list of computers in the 'File - import' menu, you will see a listing the list of computers in the 'File - import' menu, you will see a listing
of divecomputers. This list is covering a compatible set. Please check of divecomputers. This list is covering a compatible set. Please check
your users manual to check if your computer will be supported. your users manual to check if your computer will be supported.
Supported divecomputers: Supported divecomputers::
Atomics: Atomics::
Cobalt Cobalt
Cressi:
Cressi::
Edi Edi
Mares:
Mares::
Icon HD Icon HD
Nemo Nemo
Puck Puck
Air Air
Oceanic:
Oceanic::
Veo250 Veo250
VT Pro VT Pro
OSTC: *
OSTC::
DR5 DR5
2N 2N
Reefnet:
Reefnet::
Sensus Sensus
Sensus Pro Sensus Pro
Sensus Ultra Sensus Ultra
Suunto:
Suunto::
Cobra Cobra
2 2
3 3
@ -553,33 +603,36 @@ your users manual to check if your computer will be supported.
Vytec Vytec
DS DS
Zoop Zoop
Uwatec:
Uwatec::
Aladin Aladin
Memo Mouse Memo Mouse
Smart Smart
Zeagle:
Zeagle::
N2iTiON 3 N2iTiON 3
* OSTC computers are listed in the pull-down menu as OSTC. All 3 types are supported. * OSTC computers are listed in the pull-down menu as OSTC. All 3 types are supported.
Appendix B Appendix B
----------
#!/bin/bash #!/bin/bash
# #
# Small basic example script to unpack Suunto Export files # Small basic example script to unpack Suunto Export files
# for the use with Subsurface # for the use with Subsurface
# #
echo -n "Enter the directory where you stored your Suunto Divemanager export file: " echo -n "Enter the directory where you stored your Suunto Divemanager export file: "
read SuuntoExportDir read SuuntoExportDir
echo -n "Enter the name of your Suunto Divemanager export file: " echo -n "Enter the name of your Suunto Divemanager export file: "
read SuuntoExportFile read SuuntoExportFile
echo "You have entered: $SuuntoExportDir/$SuuntoExportFile" echo "You have entered: $SuuntoExportDir/$SuuntoExportFile"
cd $SuuntoExportDir cd $SuuntoExportDir
if [ -e ./$SuuntoExportFile ]; then if [ -e ./$SuuntoExportFile ]; then
mkdir SuuntoXML mkdir SuuntoXML

3
Makefile
View file

@ -195,5 +195,8 @@ uemis.o: uemis.c dive.h uemis.h
$(OSSUPPORT).o: $(OSSUPPORT).c display-gtk.h $(OSSUPPORT).o: $(OSSUPPORT).c display-gtk.h
$(CC) $(CFLAGS) $(OSSUPPORT_CFLAGS) -c $(OSSUPPORT).c $(CC) $(CFLAGS) $(OSSUPPORT_CFLAGS) -c $(OSSUPPORT).c
doc:
$(MAKE) -C Documentation doc
clean: clean:
rm -f $(OBJS) *~ $(NAME) rm -f $(OBJS) *~ $(NAME)