diff options
Diffstat (limited to 'Documentation/user-manual.html.git')
| -rw-r--r-- | Documentation/user-manual.html.git | 616 |
1 files changed, 494 insertions, 122 deletions
diff --git a/Documentation/user-manual.html.git b/Documentation/user-manual.html.git index 589ca2f5b..def10e821 100644 --- a/Documentation/user-manual.html.git +++ b/Documentation/user-manual.html.git @@ -444,7 +444,7 @@ asciidoc.install(3); <div class="paragraph"><p><span class="big">USER MANUAL</span></p></div> <div class="paragraph"><p><strong>Manual authors</strong>: Willem Ferguson, Jacco van Koll, Dirk Hohndel, Reinout Hoornweg, Linus Torvalds, Miika Turkia, Amit Chaudhuri, Jan Schubert, Salvador Cuñat, Pedro Neves</p></div> -<div class="paragraph"><p><span class="blue"><em>Version 4.5, October 2015</em></span></p></div> +<div class="paragraph"><p><span class="blue"><em>Version 4.6, January 2017</em></span></p></div> <div class="paragraph"><p>Welcome as a user of <em>Subsurface</em>, an advanced dive logging program with extensive infrastructure to describe, organize, interpret and print scuba and free dives. <em>Subsurface</em> offers many advantages over other similar @@ -458,6 +458,11 @@ Do you need a flexible way of logging dives using recreational equipment, </li> <li> <p> +Do you wish to seamlessly include GPS locations of dive sites into your dive log? +</p> +</li> +<li> +<p> Do you use two different dive computer brands, each with its own proprietary software for downloading dive logs? Do you dive with rebreathers as well as open circuit or recreational equipment? Do you use a Reefnet Sensus time-depth @@ -469,14 +474,14 @@ Do you use two different dive computer brands, each with its own proprietary <li> <p> Do you use more than one operating system? <em>Subsurface</em> is fully compatible - with Mac, Linux and Windows, letting you access your dive log on each - operating system using a single application. + with Mac, Linux and Windows, letting you access your dive log on a range of + operating systems using a single application. </p> </li> <li> <p> -Do you use Linux or Mac, but your dive computer has only Windows- based software - for downloading dive information (e.g. Mares)? <em>Subsurface</em> provides a way of +Do you use Linux or Mac, but your dive computer has only Windows-based software + for downloading dive information (e.g. Mares or Scubapro)? <em>Subsurface</em> provides a way of downloading and analyzing your dive logs on other operating systems. </p> </li> @@ -490,13 +495,18 @@ Do you need an intuitive graphical dive planner that integrates with, and takes <p> Do you need a way of storing or backing up your dive log on the Internet, letting you view your dive log from anywhere using an Internet browser? -<em>Subsurface</em> binaries are available for Windows PCs (Win XP or later), Intel -based Macs (OS/X) and many Linux distributions. <em>Subsurface</em> can be built for -many more hardware platforms and software environments where Qt and -libdivecomputer are available. +</p> +</li> +<li> +<p> +Do you wish to access or modify your dive log using a mobile phone? </p> </li> </ul></div> +<div class="paragraph"><p><em>Subsurface</em> binaries are available for Windows PCs (Win XP or later), Intel +based Macs (OS/X) and many Linux distributions. <em>Subsurface</em> can be built for +many more hardware platforms and software environments where Qt and +libdivecomputer are available.</p></div> <div class="paragraph"><p>This manual explains how to use the <em>Subsurface</em> program. To install the software, consult the <em>Downloads</em> page on the <a href="http://subsurface-divelog.org/"><em>Subsurface</em> web site</a>. @@ -1199,7 +1209,19 @@ show the nickname for that particular device instead of the model name, allowing easy identification of devices.</p></div> </div> <div class="sect3"> -<h4 id="S_EditDiveInfo">5.2.4. Updating the dive information imported from the dive computer.</h4> +<h4 id="S_MultipleDiveComputers">5.2.4. Uploading data for a specific dive from more than one dive computer</h4> +<div class="paragraph"><p>Some divers use more than one dive computer at the same time, e.g. during technical diving. +If you import the dive profiles from these different dive computers into <em>Subsurface</em>, the +profiles can be viewed independently. During upload the data from the dive computers are automatically +merged into a single dive. The different profiles are presented on the <em>Profile</em> panel with +the name of each dive computer indicated at the bottom left. +<strong>While the dive is highlighted in the <em>Dive List</em></strong>, switch between the profiles of the +different dive computers by using either the left/right arrow keyboard keys or +by selecting <em>View → Previous DC</em> or <em>View → Next DC</em>. The data in the <em>Notes</em> panel +are not affected by the specific dive computer that is selected.</p></div> +</div> +<div class="sect3"> +<h4 id="S_EditDiveInfo">5.2.5. Updating the dive information imported from the dive computer.</h4> <div class="paragraph"><p>With the uploaded dives in the <strong>Dive List</strong>, the information from the dive computer is not complete and more details must be added to have a full record of the dives. To do this, @@ -1465,7 +1487,7 @@ with two types of weights: integrated as well as a weight belt:</p></div> </div> </div> <div class="sect3"> -<h4 id="_editing_several_selected_dives_simultaneously">5.2.5. Editing several selected dives simultaneously</h4> +<h4 id="_editing_several_selected_dives_simultaneously">5.2.6. Editing several selected dives simultaneously</h4> <div class="paragraph"><p><em>METHOD 1</em>: After uploading dives from a dive computer, the dive profiles of each is shown in the <strong>Dive profile</strong> tab, as well as a few items of information @@ -1498,7 +1520,7 @@ into which this information is to be pasted. Then, from the main menu, select <e All the selected dives now contain the data initially selected in the original source dive log.</p></div> </div> <div class="sect3"> -<h4 id="_adding_bookmarks_to_a_dive">5.2.6. Adding Bookmarks to a dive</h4> +<h4 id="S_Bookmarks">5.2.7. Adding Bookmarks to a dive</h4> <div class="paragraph"><p>Many divers wish to annotate dives with text that indicate particular events, e.g. "Saw dolphins", or "Released surface buoy". This is easily done:</p></div> @@ -1535,7 +1557,7 @@ Hovering the mouse over the red bookmark, the appropriate text is shown at </div> </div> <div class="sect3"> -<h4 id="_saving_the_updated_dive_information">5.2.7. Saving the updated dive information</h4> +<h4 id="_saving_the_updated_dive_information">5.2.8. Saving the updated dive information</h4> <div class="paragraph"><p>The information entered in the <strong>Notes</strong> tab and the <strong>Equipment</strong> tab can be saved by using the two buttons on the top right hand of the <strong>Notes</strong> tab. If the <em>Apply changes</em> button @@ -1603,7 +1625,7 @@ Cochran dive logs </li> <li> <p> -UDDF-formatted dive logs (e.g. Kenozoooid) +UDDF-formatted dive logs (e.g. Kenozooid) </p> </li> <li> @@ -1648,6 +1670,16 @@ Suunto Dive Manager (DM3, DM4, DM5) </li> <li> <p> +DL7 files used by Diver’s Alert network (DAN) +</p> +</li> +<li> +<p> +Underwater technologies AV1 dive logs +</p> +</li> +<li> +<p> CSV (text-based and spreadsheet-based) dive logs, including APD CCR logs </p> </li> @@ -1709,7 +1741,102 @@ Finally, import the dives </ol></div> </div> <div class="sect3"> -<h4 id="S_ImportingDivelogsDe">5.3.4. Importing dives from <strong>divelogs.de</strong></h4> +<h4 id="S_SmartTrakImport">5.3.4. Importing Scubapro <em>SmartTrak</em> divelogs</h4> +<div class="paragraph"><p><em>SmartTrak</em> stores the raw data from a Uwatec/Scubapro dive computer along with a plethora +of other data manually added by the user, ranging from dive points to buddies data or DAN survey +info. However, this is Microsoft Windows-based propietary software by Uwatec (today Scubapro) +using Microsoft Access databases, preventing the integration the importer into the <em>Subsurface</em> +core application.</p></div> +<div class="paragraph"><p>A stand alone tool for Linux has been developed to import the <em>.slg</em> files +generated by SmartTrak to Subsurface’s <em>.xml</em> format. It can be built together +with <em>Subsurface</em> for Linux systems. Two dependencies need to be installed in +your system before building: <em>libglib2.0</em> and <em>libmdb2</em>.</p></div> +<div class="paragraph"><p>Feel free to contact the <em>Subsurface</em> development team on <a href="mailto:subsurface@subsurface-divelog.org">our mailing list</a> +for assistance in importing <em>SmartTrak</em> dive logs.</p></div> +<div class="paragraph"><p>Assuming the above dependencies +have been installed and the <em>Subsurface</em> source tree is in the directory <em>~/src/subsurface</em>, then:</p></div> +<div class="sect4"> +<h5 id="_building_em_smtk2ssrf_em">Building <em>smtk2ssrf</em></h5> +<div class="ulist"><ul> +<li> +<p> +Move to the source tree directory. +</p> +</li> +<li> +<p> +Run " $ ccmake build " and set SMARTTRAK_IMPORT option to <strong>on</strong> (off by + default). +</p> +</li> +<li> +<p> +Generate with [c] and save and exit with [g]. +</p> +</li> +<li> +<p> +Build as you prefer, using the <em>build.sh</em> script (recomended) or moving to build + directory and running <em>make</em>. +</p> +</li> +<li> +<p> +After a successful build, there will be an executable named <em>smtk2ssrf</em> in the + <em>subsurface/build</em> directory. + Copy or move it to a directory in your $PATH, e.g. <em>~/bin</em>. +</p> +</li> +</ul></div> +</div> +<div class="sect4"> +<h5 id="_running">Running</h5> +<div class="paragraph"><p><em>smtk2ssrf</em> accepts 0, 2 or more parameters. If it is launched without +parameters in a graphical user interface, a simple window +opens for choosing the <em>.slg</em> file(s) to import and a destination file to store the +<em>Subsurface</em>-formatted data into (see image below).</p></div> +<div class="imageblock" style="text-align:center;"> +<div class="content"> +<img src="images/smtk2ssrf.jpg" alt="FIGURE:Download from SmartTrak" /> +</div> +</div> +<div class="admonitionblock"> +<table><tr> +<td class="icon"> +<img src="images/icons/warning2.png" alt="Warning" /> +</td> +<td class="content">Existing data in the destination file will be +erased, so <strong>DO NOT</strong> use a regular subsurface divelog file as a destination: +rather, specify a <strong>new</strong> filename as a destination.</td> +</tr></table> +</div> +<div class="paragraph"><p>If launched from a command line with two or more parameters, the format is as follows:</p></div> +<div class="literalblock"> +<div class="content"> +<pre><code>$ smrtk2ssrf /input/file_1.slg /input/file_2.slg /output/file3.xml</code></pre> +</div></div> +<div class="paragraph"><p>where <em>input</em> is the directory containing the .slg file(s) and <em>output</em> is the +directory where the <em>Subsurface</em>-formatted output is written to. +Files <em>file_1.slg</em> and <em>file_2.slg</em> in the <em>input</em> directory are imported and stored +in <em>file3.xml</em> in the <em>output</em> directory. Check any warning and error messages +in the console or in the graphical window: some may be +relevant as support for Galileo family of dive computers is still a work in +progress.</p></div> +</div> +<div class="sect4"> +<h5 id="_merging_the_imported_dives_with_the_existing_divelog">Merging the imported dives with the existing divelog</h5> +<div class="paragraph"><p>Open the new file (generated in the previous steps) using <em>Subsurface</em> and check the dives and data. +If everything is fine, close the <em>.xml</em> file and open your regular divelog. +Then from the <strong>Main Menu</strong> select <em>Import → Import log file</em> and choose the +<em>.xml</em> file containing the imported dives: these will show in the <strong>Dive List</strong>, time +ordered, along with the existing dives. +The new dives, although time ordered, will keep the numbering system from +<em>SmartTrak</em>, so a renumbering action is needed. See the section on <a href="#S_Renumber">Renumbering +the dives</a> for instructions on this topic.</p></div> +</div> +</div> +<div class="sect3"> +<h4 id="S_ImportingDivelogsDe">5.3.5. Importing dives from <strong>divelogs.de</strong></h4> <div class="paragraph"><p>Importing dive information from <em>divelogs.de</em> is simple, using a single dialogue box. The <em>Import → Import from Divelogs.de</em> option should be selected from the Main Menu. This @@ -1728,7 +1855,7 @@ success status is shown (see image <strong>B</strong>, below). The </div> </div> <div class="sect3"> -<h4 id="S_ImportingCSVData">5.3.5. Importing data in CSV format</h4> +<h4 id="S_ImportingCSVData">5.3.6. Importing data in CSV format</h4> <div class="paragraph"><p>A comma-separated file (.csv) can be used to import dive information either as dive profiles (as in the case of the APD Inspiration and Evolution closed circuit rebreathers) or as dive metadata (in case the user keeps dive data in a spreadsheet). The <em>CSV</em> format is a universal @@ -1740,12 +1867,9 @@ to CSV format</a> for information that may be helpful for importing spreadsheet- into <em>Subsurface</em>.</p></div> <div class="sect4"> <h5 id="S_ImportingCSVDives">Importing dives in CSV format from dive computers or other dive log software</h5> -<div class="literalblock"> -<div class="content"> -<pre><code> _CSV_ files can be viewed using an ordinary text editor. A _CSV_ file is normally organized into -a single line that provides the headers (or _field names_ or _column headings_) of the data -columns, followed by the data, one record per line.</code></pre> -</div></div> +<div class="paragraph"><p><em>CSV</em> files can be viewed using an ordinary text editor. A <em>CSV</em> file is normally organized into +a single line that provides the headers (or <em>field names</em> or <em>column headings</em>) of the data +columns, followed by the data, one record per line.</p></div> <div class="paragraph"><p>There are two types of <em>CSV</em> dive logs that can be imported into <em>Subsurface</em>:</p></div> <div class="olist arabic"><ol class="arabic"> <li> @@ -1957,7 +2081,7 @@ to make these available to the <em>Subsurface</em> desktop version, <em>Subsurfa many of the functions of the desktop version, including the management and viewing of dive information. Below, we describe how to perform the above three steps using each of the two mobile apps.</p></div> -<div class="paragraph"><p>For information on using the <em>Subsurface Companion App</em>, click <a href="#S_iCompanion"><em>here</em></a>.</p></div> +<div class="paragraph"><p>For information on using the <em>Subsurface Companion App</em>, click <a href="#S_Companion"><em>here</em></a>.</p></div> <div class="sect3"> <h4 id="_storing_and_and_using_gps_locations_using_em_subsurface_mobile_em">5.4.1. Storing and and using GPS locations using <em>Subsurface-mobile</em></h4> <div class="sect4"> @@ -2052,7 +2176,7 @@ synchronising this information.</p></div> </div> </div> <div class="sect3"> -<h4 id="S_iCompanion">5.4.2. Importing GPS coordinates with the <em>Subsurface Companion App</em> for mobile phones</h4> +<h4 id="S_Companion">5.4.2. Importing GPS coordinates with the <em>Subsurface Companion App</em> for mobile phones</h4> <div class="paragraph"><p>Using the <strong>Subsurface Companion App</strong> on an <em>Android device</em> or <a href="#S_iphone"><em>iPhone</em></a> with GPS, the coordinates for the diving @@ -2422,8 +2546,13 @@ photographs that need to be loaded into <em>Subsurface</em> and click the <em>Op <img src="images/LoadImage2_f20.jpg" alt="FIGURE: Load images option" /> </div> </div> -<div class="paragraph"><p>This brings up the time synchronization dialog, shown below. The time -synchronization is not perfect between the dive computer used during a dive, +<div class="paragraph"><p>If photos are imported from the Internet, provide a URL pointing to a single photograph. +If the URL points to a directory, no images are imported: photos from the Internet +need to be imported one at a time. If photos are loaded from the Internet, <em>Subsurface</em> +assumes there is an Internet connection each time this photo is viewed within +<em>Subsurface</em>.</p></div> +<div class="paragraph"><p>Having selected the local folder ot Internet image to be imported, the time synchronization dialog appears (see image below). The time +synchronization is not perfect between the dive computer used during a dive and the camera used during that same dive. These two devices often differ by several minutes. <em>Subsurface</em> attempts to synchronize these two devices so that the exact times of photographs can be used to position photographs on @@ -2559,7 +2688,14 @@ In addition the <em>Photos</em> tab shows only the file names of the photos. If the external drive with the photos is re-connected, the photos can be seen in the normal way.</p></div> </div> <div class="sect3"> -<h4 id="S_FindMovedImages">5.5.5. Moving photographs among directories, hard disks or computers</h4> +<h4 id="_finding_out_which_dives_have_associated_photos">5.5.5. Finding out which dives have associated photos.</h4> +<div class="paragraph"><p>Inspecting each individual dive in order to determine whether there are associated photos can be time consuming. There is a +rapid way of seeing which dives have associated photos and which not: activate the <em>Photos</em> checkbox in the dropdown +list obtained by right-clicking on the header bar of the <strong>Divelist</strong>. In the <strong>Divelist</strong>, all dives with associated photographs +have an icon indicating whether the photographs were taken during the dive, just before/after the dive or both during and before/after the dive. More information is provided in the section dealing with <a href="#S_Divelist_columns">photo icons on the <strong>Divelist</strong></a>.</p></div> +</div> +<div class="sect3"> +<h4 id="S_FindMovedImages">5.5.6. Moving photographs among directories, hard disks or computers</h4> <div class="paragraph"><p>After a photograph has been loaded into <em>Subsurface</em> and associated with a specific dive, <em>Subsurface</em> saves the directory path where the photo lies as well as the file name of the photo, in order to find it when the dive is opened again. @@ -3233,7 +3369,33 @@ Graph <strong>E</strong> indicates the situation after remaining at 4.5 meters f </div> </div> <div class="sect3"> -<h4 id="_the_profile_toolbar">6.4.2. The Profile Toolbar</h4> +<h4 id="_computer_reported_events_during_dive">6.4.2. Computer-reported events during dive</h4> +<div class="paragraph"><p>Many dive computers record events during a dive. For instance, +most dive computers report alarms relating to high partial pressures of oxygen, +to rapid ascents or the exceeding of no-deco limits (NDL). +On the other hand, other events are classified as warnings and, for instance, occur when +the remaining gas in a cylinder falls below a predetermined limit, a deep stop needs to be performed or +the need to change gas during multicylinder dives. Some dive computers also report notifications, +e.g. when a safety stop is initiated or terminated or when a predetermined amount of OTUs have been incurred. +The alarms, warnings and notifications differs from one dive computer to another: some dive computers do not +report any of the above events, while others provide an extensive log of events. The reporting of events +is therefore a function of the dive computer used. In addition, <em>Subsurface</em> does not always +have the ability to detect all the events reported by a specific dive computer.</p></div> +<div class="paragraph"><p>Events are indicated by symbols on the dive profile. Notifications are shown as a white, round symbol with a letter <em>i</em>; +warnings are indicated by a yellow triangle and alarms by a red triangle. By moving the cursor over a symbol, +the explanation is given in the bottom-most line of the <em>Information Box</em> (see image below, where the cursor is positioned +over the alarm that was reported).</p></div> +<div class="imageblock" style="text-align:center;"> +<div class="content"> +<img src="images/profile_symbols.jpg" alt="FIGURE: Profile notification symbols" /> +</div> +</div> +<div class="paragraph"><p>Some dive computers report <em>bookmarks</em> that the diver has set during the dive. These are indicated as +a small red flag on the profile and are discussed more fully in the section on +<a href="#S_Bookmarks"><em>inserting bookmarks</em></a>.</p></div> +</div> +<div class="sect3"> +<h4 id="_the_profile_toolbar">6.4.3. The Profile Toolbar</h4> <div class="paragraph"><p>The dive profile can include graphs of the <strong>partial pressures</strong> of O<sub>2</sub>, N<sub>2</sub>, and He during the dive (see figure above) as well as a calculated and dive computer reported deco ceilings (only visible for deep, long, or repetitive dives). @@ -3523,7 +3685,7 @@ in slower tissues at the end of the dive.</p></div> </div> </div> <div class="sect3"> -<h4 id="_the_dive_profile_context_menu">6.4.3. The Dive Profile context menu</h4> +<h4 id="_the_dive_profile_context_menu">6.4.4. The Dive Profile context menu</h4> <div class="paragraph"><p>The context menu for the Dive Profile is accessed by right-clicking while the mouse cursor is over the Dive Profile panel. The menu allows creating Bookmarks, Gas Change Event markers, or manual CCR set-point changes @@ -3559,7 +3721,7 @@ Context Menu. It is found by selecting either a single dive or a group of dives </div> <div class="paragraph"><p>The context menu is used in many functions described below.</p></div> <div class="sect3"> -<h4 id="_customizing_the_columns_showed_in_the_strong_dive_list_strong_panel">7.1.1. Customizing the columns showed in the <strong>Dive List</strong> panel</h4> +<h4 id="S_Divelist_columns">7.1.1. Customizing the columns showed in the <strong>Dive List</strong> panel</h4> <div class="imageblock" style="text-align:center;"> <div class="content"> <img src="images/DiveListOptions.jpg" alt="Example: Dive list info options" /> @@ -3567,10 +3729,38 @@ Context Menu. It is found by selecting either a single dive or a group of dives </div> <div class="paragraph"><p>The default information in the <strong>Dive List</strong> includes, for each dive, Dive_number, Date, Rating, Dive_depth, Dive_duration and Dive_location. This information can be controlled and changed by right-clicking on the -header bar of the <strong>Dive List</strong>. For instance, a right-click on the <em>Date</em> header brings up a list of items -that can be shown in the dive list (see above). Select an item to be included in the <strong>Dive List</strong> or to be -deleted (reflected by the check symbols) and the list is immediately updated. Preferences for information +header bar of the <strong>Dive List</strong>, bringing up a list of columns +that can be shown in the dive list (see above). Check an items to be included in the <strong>Dive List</strong>. +The list is immediately updated. Preferences for information shown in the <strong>Dive List</strong> are saved and used when <em>Subsurface</em> is re-opened.</p></div> +<div class="paragraph" id="S_Photos_divelist"><p>By selecting the <em>Photos</em> checkbox in the dropdown list, an icon is shown indicating whether any photos +are associated with a particular dive. There are three icons:</p></div> +<div class="admonitionblock"> +<table><tr> +<td class="icon"> +<img src="images/icons/duringPhoto.png" alt="Note" /> +</td> +<td class="content">This dive has photographs taken during the dive, typically using an underwater camera.</td> +</tr></table> +</div> +<div class="admonitionblock"> +<table><tr> +<td class="icon"> +<img src="images/icons/outsidePhoto.png" alt="Note" /> +</td> +<td class="content">This dive has photographs taken immediately before or immediately after the dive. This is useful for +finding photos of dive teams or boats just before/after the dive, whales or other surface animals seen +just before or after the dive, or of landscapes as seen from the boat.</td> +</tr></table> +</div> +<div class="admonitionblock"> +<table><tr> +<td class="icon"> +<img src="images/icons/inAndOutPhoto.png" alt="Note" /> +</td> +<td class="content">This dive has photographs taken both during the dive and immdiately before or after the dive.</td> +</tr></table> +</div> </div> </div> <div class="sect2"> @@ -3709,9 +3899,26 @@ below shows the depth profile of two dives that were merged:</p></div> </div> </div> <div class="sect3"> -<h4 id="_undo_dive_manipulations">7.4.6. Undo dive manipulations</h4> +<h4 id="_split_selected_dives">7.4.6. Split selected dives</h4> +<div class="paragraph"><p>On some occasions, a diver reaches the surface and immediately dives again. However, +it may happen that the dive computer does not register a new dive, but continues +the previous dive due to the brief surface interval. In this case it is possible to +split a dive so that the two dives are shown as independent dives on the <strong>Dive List</strong>. +If this operation is performed, <em>Subsurface</em> scans the selected dive(s) and splits the +dive at points during the dive where the depth is less than a metre.</p></div> +</div> +<div class="sect3"> +<h4 id="_load_image_s_from_file_s">7.4.7. Load image(s) from file(s)</h4> +<div class="paragraph"><p>This topic is discussed in the section: <a href="#S_LoadImage">Adding photographs to dives</a>.</p></div> +</div> +<div class="sect3"> +<h4 id="_load_image_from_web">7.4.8. Load image from web</h4> +<div class="paragraph"><p>This topic is discussed in the section: <a href="#S_LoadImage">Adding photographs to dives</a>.</p></div> +</div> +<div class="sect3"> +<h4 id="_undo_dive_manipulations">7.4.9. Undo dive manipulations</h4> <div class="paragraph"><p>Important actions on dives or trips, described above, can be undone or redone. -This includes: <em>delete dives</em>, <em>merge dives</em>, <em>renumber dives</em> and <em>shift dive times</em>. +This includes: <em>delete dives</em>, <em>merge dives</em>, <em>split selected dives</em>, <em>renumber dives</em> and <em>shift dive times</em>. To do this after performing any of these actions, from the <strong>Main Menu</strong> select <em>Edit</em>. This brings up the possibility to <em>Undo</em> or <em>Redo</em> an action.</p></div> </div> @@ -3768,43 +3975,43 @@ Export dive information to <em>Facebook</em> </li> </ul></div> <div class="sect2"> -<h3 id="S_facebook">8.1. Exporting dive information to <em>Facebook</em></h3> +<h3 id="S_Facebook">8.1. Exporting dive information to <em>Facebook</em></h3> <div class="paragraph"><p>Export of dives to <em>Facebook</em> is handled differently from other types of export because a connection to <em>Facebook</em> is required, needing a <em>Facebook</em> userID and password. -If, from the <strong>Main Menu</strong>, you select <em>Share on → Connect to → Facebook</em>, a login screen comes up. -(image <strong>A</strong> to the left, below). Provide a <em>Facebook</em> userID and password. -Once logged into to <em>Facebook</em> , the panel -in image <strong>B</strong>, below is shown, including a <em>Disconnect from Facebook</em> button to close the -<em>Facebook</em> connection.</p></div> +From the <strong>Main Menu</strong>, select <em>Share on → Connect to → Facebook</em> (image <strong>A</strong> below) +A <em>Facebook</em> login screen appears (image <strong>B</strong> below). Provide a <em>Facebook</em> userID and password. +From the <em>Subsurface</em> window it’s easy to determine whether <em>Subsurface</em> has a valid connection to <em>Facebook</em>: +from the <strong>Main Menu</strong>, select <em>Share on</em> (image <strong>A</strong>, below). Normally, the <em>Facebook</em> option is greyed out. But +if there is a connection to <em>Facebook</em>, this option is active (i.e. in black color and can be selected).</p></div> +<div class="paragraph"><p>Once logged into to <em>Facebook</em> , a panel is shown with a message: +"<em>To disconnect Subsurface from your Facebook account, use the <em>Share on</em> menu entry</em>." +Close this message panel.</p></div> <div class="imageblock" style="text-align:center;"> <div class="content"> -<img src="images/facebook1_f20.jpg" alt="Figure: Facebook login" /> +<img src="images/facebook1.jpg" alt="Figure: Facebook login" /> </div> </div> -<div class="paragraph"><p>From the <em>Subsurface</em> window it’s easy to determine whether <em>Subsurface</em> has a valid connection to <em>Facebook</em> -From the <strong>Main Menu</strong>, select <em>Share on</em> (image <strong>A</strong>, below). Normally, the <em>Facebook</em> option is greyed out. But -if there is a connection to <em>Facebook</em>, this option is active (i.e. in black color and can be selected).</p></div> -<div class="paragraph"><p>Having established a login to <em>Facebook</em>, transferring a dive profileto a <em>Facebook</em> timeline is easy. -Ensure that the dive to be transferred to the timeline is shown in the <em>Subsurface</em> <strong>Dive Profile</strong> panel. If, from the <strong>Main Menu</strong>, you -select <em>Share on → Facebook</em> (see image <strong>A</strong> below), a dialogue box is shown, determining the amount of additional information transferred along -with the dive profile (image <strong>B</strong>, below). To transfer a dive profile to <em>Facebook</em>, the name of a -<em>Facebook</em> album is needed. The checkboxes on the left hand side let you decide how much -additional information should be transferred with the dive profile. This information is shown in the text box -on the right hand side of the panel (image <strong>B</strong>, below). You can easily edit the message that will be posted -with the dive profile. After specifying the additional information and verifying the text, select -the <em>OK</em> button that triggers the transfer to <em>Facebook</em>. After the transfer +<div class="paragraph"><p>Having established a login to <em>Facebook</em>, transferring a dive profile to a <em>Facebook</em> timeline is easy. +In the <em>Subsurface</em> <strong>Dive Profile</strong> panel, highlight the dive to be transferred. +Then, from the <strong>Main Menu</strong>, select <em>Share on → Facebook</em>. A dialogue box +is shown, determining the amount of additional information to be transferred +with the dive profile (image <strong>A</strong>, below). To transfer a dive profile to <em>Facebook</em>, the name of a +<em>Facebook</em> album is needed. The checkboxes on the left hand side determine how much +additional information is added to the dive profile, shown in the text box +on the right hand side of the panel (image <strong>A</strong>, below). Customise the message that will be posted +with the dive profile by editing any of the information. After specifying additional information +and verifying the text, select the <em>OK</em> button that triggers the transfer to <em>Facebook</em>. After the transfer is done, an acknowledgement dialogue appears, indicating it was successful.</p></div> -<div class="paragraph"><p>Both the album created and the post to your timeline will be marked as -private. In order for friends to be able to see it, -change its permissions from a regular Facebook login either in a -browser or a Facebook app.</p></div> +<div class="paragraph"><p>Both the album created and the post to your timeline are marked as +private. In order for friends to be able to see the post, +log into <em>Facebook</em> using a browser or Facebook app and change its permissions.</p></div> <div class="imageblock" style="text-align:center;"> <div class="content"> -<img src="images/facebook2_f20.jpg" alt="Figure: Facebook login" /> +<img src="images/facebook2.jpg" alt="Figure: Facebook data submission" /> </div> </div> -<div class="paragraph"><p>If required, then close the <em>Facebook</em> connection by either closing <em>Subsurface</em> or by selecting <em>File → Preferences → Facebook</em> from -the Main Menu, and clicking the appropriate button on the Facebook Preferences panel.</p></div> +<div class="paragraph"><p>If required, then close the <em>Facebook</em> connection by selecting, from the <strong>Main Menu</strong>, +<em>Share on → Disconnect from → Facebook</em> (image <strong>B</strong> above).</p></div> </div> <div class="sect2"> <h3 id="S_Export_other">8.2. Export dive information to other destinations or formats</h3> @@ -3892,6 +4099,24 @@ Universal Dive Data Format (<em>UDDF</em>). Refer to <em>http://uddf.org</em> fo <div class="ulist"><ul> <li> <p> +<em>TeX</em> format, a file for printing using the TeX typesetting + software. Choose a filename with a <em>.tex</em> extension. You will also + need a template file, that can be obtained from + <a href="http://www.atdotde.de/%7erobert/subsurfacetemplate/">http://www.atdotde.de/~robert/subsurfacetemplate/</a> in the same + directory as the <em>.tex</em> file. The file can then be processed with + plain TeX (not LaTeX), for example by running <em>pdftex filename.tex</em> + on the command line. +</p> +</li> +</ul></div> +<div class="imageblock" style="text-align:center;"> +<div class="content"> +<img src="images/texexample.png" alt="Figure: Export to TeX" /> +</div> +</div> +<div class="ulist"><ul> +<li> +<p> <em>Image depths</em>, which creates a text file that contains the file names of all photos or images attached to any of the selected dives in the <em>Dive List</em>, together with the depth underwater where @@ -4076,7 +4301,45 @@ process could be used for the Cloud-based storage of dive logs.</p></div> </div> </div> <div class="sect1"> -<h2 id="S_PrintDivelog">10. Printing a dive log</h2> +<h2 id="S_user_space">10. Several <em>Subsurface</em> users on one desktop computer</h2> +<div class="sectionbody"> +<div class="paragraph"><p>A frequent need is for two or more persons to use <em>Subsurface</em> on the same desktop computer. For instance +members of a household may use the same computer or one family member may perform dive uploads for other +family members/friends. There are two approaches for doing this.</p></div> +<div class="paragraph"><p><strong>A)</strong> If the different users of a desktop computer do not log onto the desktop/laptop under different user names + then the simplest way is for each person to use her/his own divelog file within Subsurface. In this case John + would work with the <em>Subsurface</em> file <em>johns-divelog</em> and Joan would use <em>joans-divelog</em>. Select + the appropriate dive log by selecting, from the <strong>Main Menu</strong>, <em>File → Open logbook</em> and then select your own + dive log file from the list of files lower down in the menu. However, a problem arises if the users + prefer different settings for <em>Subsurface</em>. For instance, one diver may prefer to see the dive ceiling in the + <strong>Profile Panel</strong> and photos icons in the <strong>Dive List</strong>, while the other may not have these preferences. In addition, + the cloud connection is normally unique for each <em>Subsurface</em> installation and if more than one user wishes to save + dive data on the cloud, it is inconvenient to open the <strong>Preferences</strong> and change the user-ID data every time + the cloud is accessed. To solve these problems, launch <em>Subsurface</em> with a <em>--user=<user name></em> command-line option. + John can then activate <em>Subsurface</em> with this command-line instruction:</p></div> +<div class="literalblock"> +<div class="content"> +<pre><code>subsurface --user=John</code></pre> +</div></div> +<div class="paragraph"><p>while Joan can launch <em>Subsurface</em> using:</p></div> +<div class="literalblock"> +<div class="content"> +<pre><code>subsurface --user=Joan</code></pre> +</div></div> +<div class="paragraph"><p>In this case, each user’s preferences, settings and cloud access information are stored separately, allowing + each diver to interact with <em>Subsurface</em> in her/his preferred way and with individual cloud access. The above + process can be made user-friendly by creating a link/shortcut with a desktop icon that executes the above + command-line instruction. Use of the <em>--user=</em> option therefore enables each user to create, maintain and + backup a separate dive log within a personalised user interface. This way, when each diver launches <em>Subsurface</em>, + it opens with the correct dive log as well as the appropriate display and backup preferences, and each diver + can access their own divelog on a mobile device using <a href="https://subsurface-divelog.org/documentation/subsurface-mobile-user-manual"><em>Subsurface-Mobile</em></a>.</p></div> +<div class="paragraph"><p><strong>B)</strong> On the other hand, if the users log onto the same computer using different userIDs and passwords (i.e. users each +have a separate user space), <em>Subsurface</em> is available independently to each user and every diver automatically has a separate +user profile and settings, including unique cloud and <em>Subsurface-Mobile</em> access.</p></div> +</div> +</div> +<div class="sect1"> +<h2 id="S_PrintDivelog">11. Printing a dive log</h2> <div class="sectionbody"> <div class="paragraph"><p><em>Subsurface</em> provides a simple and flexible way to print a whole dive log or only a few selected dives. Pre-installed templates or a custom written template can be used to choose where the data are fitted into the page.</p></div> @@ -4217,7 +4480,7 @@ Below is a (rather small) example of the output for one particular page.</p></di </div> </div> <div class="sect2"> -<h3 id="_writing_a_custom_print_template_advanced">10.1. Writing a custom print template (advanced)</h3> +<h3 id="_writing_a_custom_print_template_advanced">11.1. Writing a custom print template (advanced)</h3> <div class="paragraph"><p>Writing a custom template is an effective way to produce highly customized printouts. Subsurface uses HTML templates to render printing. You can create a template, export a new template, import an existing template and delete an existing template by using the appropriate buttons under the <em>Template</em> dropdown list in the print dialogue. See <a href="#S_APPENDIX_E">APPENDIX E</a> for information on how @@ -4226,14 +4489,14 @@ to write or modify a template.</p></div> </div> </div> <div class="sect1"> -<h2 id="S_Configure">11. Configuring a dive computer</h2> +<h2 id="S_Configure">12. Configuring a dive computer</h2> <div class="sectionbody"> <div class="paragraph"><p><em>Subsurface</em> lets you configure a dive computer. Currently the Heinrichs-Weikamp (OSTC 2, OSTC 3) and Suunto Vyper (Stinger, Mosquito, D3, Vyper, Vytec, Cobra, Gekko and Zoop) family of dive computers are supported. A large number of settings of these dive computers can be read and changed to different values. To begin, be sure the appropriate hardware driver is installed for the dive computer (also required for downloading dives) and the device name of the dive computer is known. -See <a href="#_appendix_a_operating_system_specific_information_for_importing_dive _information_from_a_dive_computer">APPENDIX A</a> for information on how to do this.</p></div> +See <a href="#_appendix_a_operating_system_specific_information_for_importing_dive_information_from_a_dive_computer">APPENDIX A</a> for information on how to do this.</p></div> <div class="paragraph"><p>Once the dive computer is connected to the <em>Subsurface</em> computer, select <em>File → Configure dive computer</em> from the <em>Main Menu</em>. Select the appropriate device name (or mount point) in the dropdown list at the @@ -4280,7 +4543,7 @@ computer model from the panel on the left-hand (see image below).</p></div> </div> </div> <div class="sect1"> -<h2 id="S_Preferences">12. Setting user <em>Preferences</em> for <em>Subsurface</em></h2> +<h2 id="S_Preferences">13. Setting user <em>Preferences</em> for <em>Subsurface</em></h2> <div class="sectionbody"> <div class="paragraph"><p>There are several user-definable settings within <em>Subsurface</em>, found by selecting <em>File → Preferences</em>, mostly affecting the way in which <em>Subsurface</em> @@ -4292,7 +4555,7 @@ session and are not saved. In order to apply new settings permanently, select the <em>Save</em> button. If you do not wish to apply the new preferences, select <em>Cancel</em>.</p></div> <div class="sect2"> -<h3 id="_defaults">12.1. Defaults</h3> +<h3 id="_defaults">13.1. Defaults</h3> <div class="paragraph"><p>There are several headings in the <strong>Defaults</strong> panel:</p></div> <div class="imageblock" style="text-align:center;"> <div class="content"> @@ -4366,7 +4629,7 @@ apply the new preferences, select <em>Cancel</em>.</p></div> </ul></div> </div> <div class="sect2"> -<h3 id="_units">12.2. Units</h3> +<h3 id="_units">13.2. Units</h3> <div class="imageblock" style="text-align:center;"> <div class="content"> <img src="images/Pref2_f23.jpg" alt="FIGURE: Preferences Units page" /> @@ -4384,7 +4647,7 @@ traditional coordinates (degrees, minutes, seconds) or as decimal degrees Choose the appropriate option.</p></div> </div> <div class="sect2"> -<h3 id="_graph">12.3. Graph</h3> +<h3 id="_graph">13.3. Graph</h3> <div class="paragraph"><p>This panel has three sections:</p></div> <div class="imageblock" id="S_CCR_options" style="text-align:center;"> <div class="content"> @@ -4549,7 +4812,7 @@ was no gas switch to such a cylinder), then these cylinders are omitted from tha </ul></div> </div> <div class="sect2"> -<h3 id="_language">12.4. Language</h3> +<h3 id="_language">13.4. Language</h3> <div class="paragraph"><p>Choose a language that <em>Subsurface</em> will use.</p></div> <div class="imageblock" style="text-align:center;"> <div class="content"> @@ -4566,7 +4829,7 @@ effect</strong>.</p></div> <div class="paragraph"><p>In this section also specify appropriate date an time formats for showing dive details.</p></div> </div> <div class="sect2"> -<h3 id="_network">12.5. Network</h3> +<h3 id="_network">13.5. Network</h3> <div class="paragraph"><p>This panel facilitates communication between <em>Subsurface</em> and data sources on the Internet. This is important, for instance, when <em>Subsurface</em> needs to communicate with web services such as Cloud storage or the <a href="#S_Companion"><em>Subsurface Companion app</em></a>. These Internet requirements are determined by your type of @@ -4622,7 +4885,7 @@ from your ISP. </ul></div> </div> <div class="sect2"> -<h3 id="_georeference">12.6. Georeference</h3> +<h3 id="_georeference">13.6. Georeference</h3> <div class="paragraph"><p><em>Subsurface</em> provides a geo-lookup service (that is, given the coordinates of a dive site) derived from a click on the <strong>Dive Map panel</strong> at the bottom right of the <em>Subsurface</em> window, or from a GPS instrument or from the <em>Subsurface</em> Companion app). A search on the Internet is done to find @@ -4638,7 +4901,7 @@ or <em>City/State/Country</em> (see image below).</p></div> </div> </div> <div class="sect1"> -<h2 id="S_DivePlanner">13. The <em>Subsurface</em> dive planner</h2> +<h2 id="S_DivePlanner">14. The <em>Subsurface</em> dive planner</h2> <div class="sectionbody"> <div class="paragraph"><p>Dive planning is an advanced feature of <em>Subsurface</em>, accessed by selecting <em>Log → Plan Dive</em> from the main menu. It allows calculation of @@ -4694,7 +4957,7 @@ A user who is not absolutely sure about any of the above requirements should not </ul></div> </div></div> <div class="sect2"> -<h3 id="_the_em_subsurface_em_dive_planner_screen">13.1. The <em>Subsurface</em> dive planner screen</h3> +<h3 id="_the_em_subsurface_em_dive_planner_screen">14.1. The <em>Subsurface</em> dive planner screen</h3> <div class="paragraph"><p>Like the <em>Subsurface</em> dive log, the planner screen is divided into several sections (see image below). The <strong>setup</strong> parameters for a dive are entered into the sections on the left hand side of the screen. They are: Available Gases, Rates, Planning, Gas Options and Notes.</p></div> @@ -4711,7 +4974,7 @@ any warning messages about the dive plan are printed.</p></div> </div> </div> <div class="sect2"> -<h3 id="_open_circuit_dives">13.2. Open circuit dives</h3> +<h3 id="_open_circuit_dives">14.2. Open circuit dives</h3> <div class="ulist"><ul> <li> <p> @@ -4817,7 +5080,7 @@ The most efficient way to create a dive profile is to enter the appropriate valu </li> </ul></div> <div class="sect3"> -<h4 id="_recreational_dives">13.2.1. Recreational dives</h4> +<h4 id="_recreational_dives">14.2.1. Recreational dives</h4> <div class="paragraph"><p>Recreational mode is what comes closest to planning a dive based on the non-decompression limit (NDL). It computes the maximum time a diver can stay at the current depth without needing mandatory decompression stops and without using more than the existing gas (minus a reserve). The planner automatically takes @@ -4908,7 +5171,7 @@ text box at the bottom right of the panel, requiring sufficient air for buddy-sh </div> </div> <div class="sect3"> -<h4 id="_non_recreational_open_circuit_dives_including_decompression">13.2.2. Non-recreational open circuit dives, including decompression</h4> +<h4 id="_non_recreational_open_circuit_dives_including_decompression">14.2.2. Non-recreational open circuit dives, including decompression</h4> <div class="paragraph"><p>Non-recreational dive planning involves exceeding the no-deco limits and/or using multiple breathing gases. These dives are planned in three stages:</p></div> <div class="paragraph"><p><strong>a) Nitrogen management</strong>: This is done by specifying the rates for descent and ascent, @@ -5038,7 +5301,7 @@ the transitions are shown separately from the segment durations at a particular </div> </div> <div class="sect2"> -<h3 id="_planning_pscr_dives">13.3. Planning pSCR dives</h3> +<h3 id="_planning_pscr_dives">14.3. Planning pSCR dives</h3> <div class="paragraph"><p>To plan a dive using a passive semi-closed rebreather (pSCR), select <em>pSCR</em> rather than <em>Open circuit</em> in the dropdown list. The parameters of the pSCR dive can be set by selecting <em>File → Preferences → Graph</em> @@ -5059,7 +5322,7 @@ in the loop due to the oxygen drop across the mouthpiece of the pSCR equipment.< </div> </div> <div class="sect2"> -<h3 id="_planning_ccr_dives">13.4. Planning CCR dives</h3> +<h3 id="_planning_ccr_dives">14.4. Planning CCR dives</h3> <div class="paragraph"><p>To plan a dive using a closed circuit rebreather, select the <em>CCR</em> option in the dropdown list, circled in blue in the image below.</p></div> <div class="paragraph"><p><strong>Available gases</strong>: In the <em>Available gases</em> table, enter the cylinder information for the @@ -5084,7 +5347,7 @@ this is calculated for bail out ascents.</p></div> so gas consumptions of 0 liters are the norm.</p></div> </div> <div class="sect2"> -<h3 id="S_Replan">13.5. Modifying an existing dive plan</h3> +<h3 id="S_Replan">14.5. Modifying an existing dive plan</h3> <div class="paragraph"><p>Normally, when a dive plan has been saved, it is accessible from the <strong>Dive List</strong>, like any other dive log. Within the <strong>Dive List</strong> there is no way to change a saved dive plan. To change a dive plan, select it on the <strong>Dive List</strong>. Then, in the main menu, @@ -5097,7 +5360,7 @@ dives are considered two versions of the same dive and do not influence other each during decompression calculation (see next section).</p></div> </div> <div class="sect2"> -<h3 id="_planning_for_repetitive_dives">13.6. Planning for repetitive dives</h3> +<h3 id="_planning_for_repetitive_dives">14.6. Planning for repetitive dives</h3> <div class="paragraph"><p>Repetitive dives can easily be planned if the dates and start times of the repetitive dive set are specified appropriately in the top left-hand <em>Start Time</em> field. <em>Subsurface</em> @@ -5114,7 +5377,7 @@ this configuration, highlight the template dive in the <strong>Dive List</strong planner: the planner takes into account the configuration in the highlighted dive.</p></div> </div> <div class="sect2"> -<h3 id="_printing_the_dive_plan">13.7. Printing the dive plan</h3> +<h3 id="_printing_the_dive_plan">14.7. Printing the dive plan</h3> <div class="paragraph"><p>Selecting the <em>Print</em> button in the planner allows printing of the <em>Dive Plan Details</em> for wet notes. You can also cut and paste the <em>Dive Plan Details</em> to include in a text file or word processing document.</p></div> @@ -5128,16 +5391,124 @@ accessed in the same way as during the planning process. The only way to print t dive plan is to use the <em>File → Print</em> function on the main menu in the same way as for dive logs or by copy and paste to a word processor.</p></div> </div> +<div class="sect2"> +<h3 id="S_MergeDivePlan">14.8. Saving a dive with its dive plan</h3> +<div class="paragraph"><p>In the section dealing with <a href="#S_MultipleDiveComputers">dives using more than one dive computer</a> +we discussed the way in which multiple profiles for a single dive can be viewed using the +left-arrow and right-arrow keyboard keys. A similar method can be used for saving a dive plan +with the profile of the actual dive, once this has been uploaded into <em>Subsurface</em>. +In order to do this:</p></div> +<div class="ulist"><ul> +<li> +<p> +Do the dive planning and save the final plan in the <em>Dive List</em>. +</p> +</li> +<li> +<p> +After diving, upload the dive data from the dive computer. +</p> +</li> +<li> +<p> +Change the date and time of the <em>dive plan</em> to coincide with that of the + real-life dive from the <em>dive computer</em>. +</p> +</li> +<li> +<p> +In the <em>Dive List</em>, highlight the dive plan as well as the data for the real dive + and merge the two dives, making use of the Dive List Context Menu + (available by righ-clicking a dive). +</p> +</li> +</ul></div> +<div class="paragraph"><p>The text version of the dive plan is appended to the Notes in the <em>Notes Tab</em>. With this +merged dive highlighted in the <em>Dive List</em>, switch +between the planned profile and the real-life profile using the righ-arrow/left-arrow keyboard keys.</p></div> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_running_em_subsurface_em_from_the_command_line">15. Running <em>Subsurface</em> from the command-line</h2> +<div class="sectionbody"> +<div class="paragraph"><p><em>Subsurface</em> can be launched from the command-line to set some specialised settings or as +part of an script-based automated process for manipulating a dive log. The format for launching <em>Subsurface</em> from the +command-line is:</p></div> +<div class="literalblock"> +<div class="content"> +<pre><code>subsurface [options] [logfile ...] [--import logfile ...]</code></pre> +</div></div> +<div class="paragraph"><p>The options include:</p></div> +<div class="tableblock"> +<table rules="all" +width="100%" +frame="border" +cellspacing="0" cellpadding="4"> +<col width="50%" /> +<col width="50%" /> +<tbody> +<tr> +<td align="left" valign="top"><p class="table"><strong>Command-line option</strong></p></td> +<td align="left" valign="top"><p class="table"><strong>Description</strong></p></td> +</tr> +<tr> +<td align="left" valign="top"><p class="table">--help</p></td> +<td align="left" valign="top"><p class="table">Print a summary of the command-line options</p></td> +</tr> +<tr> +<td align="left" valign="top"><p class="table">-h</p></td> +<td align="left" valign="top"><p class="table">Print a summary of the command-line options</p></td> +</tr> +<tr> +<td align="left" valign="top"><p class="table">--import logfile</p></td> +<td align="left" valign="top"><p class="table">A file name before this option is treated as an existing dive log, everything after is imported into the existing dive log</p></td> +</tr> +<tr> +<td align="left" valign="top"><p class="table">--verbose</p></td> +<td align="left" valign="top"><p class="table">Print debug information while running <em>Subsurface</em></p></td> +</tr> +<tr> +<td align="left" valign="top"><p class="table">-v</p></td> +<td align="left" valign="top"><p class="table">Print debug information while running <em>Subsurface</em></p></td> +</tr> +<tr> +<td align="left" valign="top"><p class="table">-v -v</p></td> +<td align="left" valign="top"><p class="table">Print even more debug information while running <em>Subsurface</em></p></td> +</tr> +<tr> +<td align="left" valign="top"><p class="table">--version</p></td> +<td align="left" valign="top"><p class="table">Prints the current version of <em>Subsurface</em>.</p></td> +</tr> +<tr> +<td align="left" valign="top"><p class="table">--survey</p></td> +<td align="left" valign="top"><p class="table">Opens the <a href="#S_UserSurvey">user survey</a> immediately after starting <em>Subsurface</em></p></td> +</tr> +<tr> +<td align="left" valign="top"><p class="table">--user=<username></p></td> +<td align="left" valign="top"><p class="table">Choose the <a href="#S_user_space">configuration space</a> of user <username></p></td> +</tr> +<tr> +<td align="left" valign="top"><p class="table">--cloud-timeout=<duration></p></td> +<td align="left" valign="top"><p class="table">Set the timeout for cloud connection (0 < duration < 60). This enables longer timeouts for slow Internet connections</p></td> +</tr> +<tr> +<td align="left" valign="top"><p class="table">--win32console</p></td> +<td align="left" valign="top"><p class="table">Create a dedicated console if needed (Windows only). Add this option before everything else</p></td> +</tr> +</tbody> +</table> +</div> </div> </div> <div class="sect1"> -<h2 id="_description_of_the_subsurface_main_menu_items">14. Description of the Subsurface Main Menu items</h2> +<h2 id="_description_of_the_subsurface_main_menu_items">16. Description of the Subsurface Main Menu items</h2> <div class="sectionbody"> <div class="paragraph"><p>This section describes the functions and operation of the items in the Main Menu of Subsurface. Several of the items below are links to sections of this manual dealing with the appropriate operations.</p></div> <div class="sect2"> -<h3 id="_file">14.1. File</h3> +<h3 id="_file">16.1. File</h3> <div class="ulist"><ul> <li> <p> @@ -5216,7 +5587,7 @@ dealing with the appropriate operations.</p></div> </ul></div> </div> <div class="sect2"> -<h3 id="_edit">14.2. Edit</h3> +<h3 id="_edit">16.2. Edit</h3> <div class="ulist"><ul> <li> <p> @@ -5226,7 +5597,7 @@ The Edit option allows one to undo or redo an action, e.g. deleting dives. </ul></div> </div> <div class="sect2"> -<h3 id="_import">14.3. Import</h3> +<h3 id="_import">16.3. Import</h3> <div class="ulist"><ul> <li> <p> @@ -5255,7 +5626,7 @@ The Edit option allows one to undo or redo an action, e.g. deleting dives. </ul></div> </div> <div class="sect2"> -<h3 id="_log">14.4. Log</h3> +<h3 id="_log">16.4. Log</h3> <div class="ulist"><ul> <li> <p> @@ -5314,7 +5685,7 @@ The Edit option allows one to undo or redo an action, e.g. deleting dives. </ul></div> </div> <div class="sect2"> -<h3 id="_view">14.5. View</h3> +<h3 id="_view">16.5. View</h3> <div class="ulist"><ul> <li> <p> @@ -5351,6 +5722,7 @@ The Edit option allows one to undo or redo an action, e.g. deleting dives. <li> <p> <em>Prev DC</em> - Switch to data from previous dive computer, if a single dive was logged from more than one. + See the sections on <a href="#S_MultipleDiveComputers">using multiple dive computers for the same dive</a> and <a href="#S_MergeDivePlan">Saving an uploaded dive with its dive plan</a>. </p> </li> <li> @@ -5366,7 +5738,7 @@ The Edit option allows one to undo or redo an action, e.g. deleting dives. </ul></div> </div> <div class="sect2"> -<h3 id="_share_on">14.6. Share on</h3> +<h3 id="_share_on">16.6. Share on</h3> <div class="ulist"><ul> <li> <p> @@ -5376,7 +5748,7 @@ The Edit option allows one to undo or redo an action, e.g. deleting dives. </ul></div> </div> <div class="sect2"> -<h3 id="_help">14.7. Help</h3> +<h3 id="_help">16.7. Help</h3> <div class="ulist"><ul> <li> <p> @@ -5406,10 +5778,10 @@ The Edit option allows one to undo or redo an action, e.g. deleting dives. </div> </div> <div class="sect1"> -<h2 id="_appendix_a_operating_system_specific_information_for_importing_dive_information_from_a_dive_computer">15. APPENDIX A: Operating system specific information for importing dive information from a dive computer.</h2> +<h2 id="_appendix_a_operating_system_specific_information_for_importing_dive_information_from_a_dive_computer">17. APPENDIX A: Operating system specific information for importing dive information from a dive computer.</h2> <div class="sectionbody"> <div class="sect2"> -<h3 id="_make_sure_that_the_os_has_the_required_drivers_installed">15.1. Make sure that the OS has the required drivers installed</h3> +<h3 id="_make_sure_that_the_os_has_the_required_drivers_installed">17.1. Make sure that the OS has the required drivers installed</h3> <div class="admonitionblock"> <table><tr> <td class="icon"> @@ -5450,7 +5822,7 @@ On a Mac users sometimes have to manually hunt for the correct </ul></div> </div> <div class="sect2"> -<h3 id="S_HowFindDeviceName">15.2. How to Find the Device Name for USB devices and set its write permission</h3> +<h3 id="S_HowFindDeviceName">17.2. How to Find the Device Name for USB devices and set its write permission</h3> <div class="admonitionblock"> <table><tr> <td class="icon"> @@ -5558,7 +5930,7 @@ port, the dive computer interface can connect and you should be able to import dives.</p></div> </div> <div class="sect2"> -<h3 id="S_HowFindBluetoothDeviceName">15.3. Manually setting up Bluetooth enabled devices</h3> +<h3 id="S_HowFindBluetoothDeviceName">17.3. Manually setting up Bluetooth enabled devices</h3> <div class="admonitionblock"> <table><tr> <td class="icon"> @@ -5588,7 +5960,7 @@ manufacturer’s user guide. When using a Shearwater Predator/Petrel/Nerd, s </li> </ul></div> <div class="sect3"> -<h4 id="_on_windows_2">15.3.1. On Windows:</h4> +<h4 id="_on_windows_2">17.3.1. On Windows:</h4> <div class="paragraph"><p>Bluetooth is most likely already enabled. For pairing with the dive computer choose <em>Control Panel → Bluetooth Devices → Add Wireless Device</em>. This should bring up a dialog showing your dive computer (which should be in Bluetooth mode) and @@ -5601,7 +5973,7 @@ this COM port already. If not, enter it manually.</p></div> other software, remove the existing pairing with the dive computer.</p></div> </div> <div class="sect3"> -<h4 id="_on_macos">15.3.2. On MacOS:</h4> +<h4 id="_on_macos">17.3.2. On MacOS:</h4> <div class="paragraph"><p>Click on the Bluetooth symbol in the menu bar and select <em>Set up Bluetooth Device…</em>. The dive computer should then show up in the list of devices. Select it and go through the pairing process. This step should only be needed once for @@ -5610,7 +5982,7 @@ initial setup.</p></div> <em>Device or Mount Point</em> drop-down in the <em>Subsurface</em> <strong>Import</strong> dialog.</p></div> </div> <div class="sect3"> -<h4 id="_on_linux">15.3.3. On Linux</h4> +<h4 id="_on_linux">17.3.3. On Linux</h4> <div class="paragraph"><p>Be sure Bluetooth is enabled on the <em>Subsurface</em> computer. On most common distributions this should be true out of the box and pairing should be straightforward. For instance, Gnome3 shows a @@ -5819,10 +6191,10 @@ let the Subsurface developers know on the user forum or the developer mailing li </div> </div> <div class="sect1"> -<h2 id="_appendix_b_dive_computer_specific_information_for_importing_dive_information">16. APPENDIX B: Dive Computer specific information for importing dive data.</h2> +<h2 id="_appendix_b_dive_computer_specific_information_for_importing_dive_information">18. APPENDIX B: Dive Computer specific information for importing dive data.</h2> <div class="sectionbody"> <div class="sect2"> -<h3 id="S_ImportUemis">16.1. Importing from Uemis Zurich</h3> +<h3 id="S_ImportUemis">18.1. Importing from Uemis Zurich</h3> <div class="admonitionblock"> <table><tr> <td class="icon"> @@ -5860,7 +6232,7 @@ may have to do this more than once, depending on how many dives are stored on the dive computer.</p></div> </div> <div class="sect2"> -<h3 id="S_ImportingGalileo">16.2. Importing from Uwatec Galileo</h3> +<h3 id="S_ImportingGalileo">18.2. Importing from Uwatec Galileo</h3> <div class="admonitionblock"> <table><tr> <td class="icon"> @@ -5892,7 +6264,7 @@ the download page for the ScubaPro SmartTrak software.</p></div> available for OSX 10.6 or higher.</p></div> </div> <div class="sect2"> -<h3 id="S_ImportingDR5">16.3. Importing from Heinrichs Weikamp DR5</h3> +<h3 id="S_ImportingDR5">18.3. Importing from Heinrichs Weikamp DR5</h3> <div class="admonitionblock"> <table><tr> <td class="icon"> @@ -5910,7 +6282,7 @@ factors in the <em>Graph Settings</em> in <em>Subsurface</em> to generate a deco </div> </div> <div class="sect2"> -<h3 id="S_ImportingXDeep">16.4. Importing from xDEEP BLACK</h3> +<h3 id="S_ImportingXDeep">18.4. Importing from xDEEP BLACK</h3> <div class="admonitionblock"> <table><tr> <td class="icon"> @@ -5927,7 +6299,7 @@ factors in the <em>Graph Settings</em> in <em>Subsurface</em> to generate a deco </div> </div> <div class="sect2"> -<h3 id="_importing_from_shearwater_predator_petrel_nerd_using_bluetooth">16.5. Importing from Shearwater Predator/Petrel/Nerd using Bluetooth</h3> +<h3 id="_importing_from_shearwater_predator_petrel_nerd_using_bluetooth">18.5. Importing from Shearwater Predator/Petrel/Nerd using Bluetooth</h3> <div class="admonitionblock"> <table><tr> <td class="icon"> @@ -5938,7 +6310,7 @@ factors in the <em>Graph Settings</em> in <em>Subsurface</em> to generate a deco </div> </div> <div class="sect2"> -<h3 id="S_PoseidonMkVI">16.6. Importing from Poseidon MkVI Discovery</h3> +<h3 id="S_PoseidonMkVI">18.6. Importing from Poseidon MkVI Discovery</h3> <div class="admonitionblock"> <table><tr> <td class="icon"> @@ -5974,7 +6346,7 @@ Redbook format dive log (file with .cvsr extension). This is a compressed <div class="paragraph"><p><em>Subsurface</em> accesses the .txt and the .csv files to get dive log information.</p></div> </div> <div class="sect2"> -<h3 id="_importing_from_apd_inspiration_evolution_ccr">16.7. Importing from APD Inspiration/Evolution CCR</h3> +<h3 id="_importing_from_apd_inspiration_evolution_ccr">18.7. Importing from APD Inspiration/Evolution CCR</h3> <div class="admonitionblock"> <table><tr> <td class="icon"> @@ -6069,7 +6441,7 @@ by the APD equipment but can be manually entered in the <em>Equipment</em> Tab.< </div> </div> <div class="sect1"> -<h2 id="_appendix_c_exporting_dive_log_information_from_external_dive_log_software">17. APPENDIX C: Exporting Dive log information from external dive log software.</h2> +<h2 id="_appendix_c_exporting_dive_log_information_from_external_dive_log_software">19. APPENDIX C: Exporting Dive log information from external dive log software.</h2> <div class="sectionbody"> <div class="paragraph"><p>The import of dive log data from external dive log software is mostly performed using @@ -6095,7 +6467,7 @@ Import the accessible dive log data into <em>Subsurface</em>. data from foreign dive log software. The procedures below mostly apply to Linux and/or Windows.</p></div> <div class="sect2"> -<h3 id="S_ImportingDivesSuunto">17.1. Exporting from <strong>Suunto Divemanager (DM3, DM4 or DM5)</strong></h3> +<h3 id="S_ImportingDivesSuunto">19.1. Exporting from <strong>Suunto Divemanager (DM3, DM4 or DM5)</strong></h3> <div class="admonitionblock"> <table><tr> <td class="icon"> @@ -6264,7 +6636,7 @@ The dives are now exported to the file DM4.bak (or DM5.bak) </ol></div> </div> <div class="sect2"> -<h3 id="_exporting_from_atomic_logbook">17.2. Exporting from Atomic Logbook</h3> +<h3 id="_exporting_from_atomic_logbook">19.2. Exporting from Atomic Logbook</h3> <div class="admonitionblock" id="Atomic_Export"> <table><tr> <td class="icon"> @@ -6279,7 +6651,7 @@ be directly imported to Subsurface.</td> </div> </div> <div class="sect2"> -<h3 id="_exporting_from_mares_dive_organiser_v2_1">17.3. Exporting from Mares Dive Organiser V2.1</h3> +<h3 id="_exporting_from_mares_dive_organiser_v2_1">19.3. Exporting from Mares Dive Organiser V2.1</h3> <div class="admonitionblock" id="Mares_Export"> <table><tr> <td class="icon"> @@ -6322,7 +6694,7 @@ The password for accessing the .zip file is <em>mares</em>. </ol></div> </div> <div class="sect2"> -<h3 id="S_ImportingDivingLog">17.4. Exporting from <strong>DivingLog 5.0 and 6.0</strong></h3> +<h3 id="S_ImportingDivingLog">19.4. Exporting from <strong>DivingLog 5.0 and 6.0</strong></h3> <div class="admonitionblock"> <table><tr> <td class="icon"> @@ -6370,7 +6742,7 @@ save the log file in Subsurface.</p></div> </div> </div> <div class="sect1"> -<h2 id="_appendix_d_exporting_a_spreadsheet_to_csv_format">18. APPENDIX D: Exporting a spreadsheet to CSV format</h2> +<h2 id="_appendix_d_exporting_a_spreadsheet_to_csv_format">20. APPENDIX D: Exporting a spreadsheet to CSV format</h2> <div class="sectionbody"> <div class="paragraph" id="S_Appendix_D"><p>Many divers keep a dive log in some form of digital file, commonly a spreadsheet with various fields of information. These logs can be easily imported into <em>Subsurface</em> after the @@ -6433,7 +6805,7 @@ In Libreoffice Calc the time format should be set to minutes:seconds - [mm]:ss a </div> <div class="paragraph"><p>Double check the .CSV file by opening it with a text editor, and then import the dive data as explained on the section <a href="#S_ImportingCSVDives">Importing CSV dives</a>.</p></div> <div class="sect2"> -<h3 id="_microsoft_em_excel_em">18.1. Microsoft <em>Excel</em></h3> +<h3 id="_microsoft_em_excel_em">20.1. Microsoft <em>Excel</em></h3> <div class="paragraph"><p>The field delimiter (called "<em>list separator</em>" in Microsoft manuals) is not accessible from within <em>Excel</em> and needs to be set through the <em>Microsoft Control Panel</em>. After changing the separator character, all software on the Windows machine uses the new character as a separator. @@ -6507,7 +6879,7 @@ explained on the section <a href="#S_ImportingCSVDives">Importing CSV dives</a>. </div> </div> <div class="sect1"> -<h2 id="S_APPENDIX_E">19. APPENDIX E: Writing a custom print template</h2> +<h2 id="S_APPENDIX_E">21. APPENDIX E: Writing a custom print template</h2> <div class="sectionbody"> <div class="paragraph"><p><em>Subsurface</em> has a way to create or modify templates for printing dive logs to produce customized printouts of them. Templates written in HTML, as well as a simple @@ -6552,7 +6924,7 @@ Table) can be modified in this way. After completing the edits, use the <em>Expo dialogue to save the new template using a new template name.</p></div> <div class="paragraph"><p>To write a custom template, the following elements must exist so the template will be correctly handled and rendered.</p></div> <div class="sect2"> -<h3 id="_main_dive_loop">19.1. Main dive loop</h3> +<h3 id="_main_dive_loop">21.1. Main dive loop</h3> <div class="paragraph"><p><em>Subsurface</em> exports a dive list called (<strong>dives</strong>) to the <em>Grantlee</em> back end. It is possible to iterate over the list as follows: .template.html</p></div> <div class="literalblock"> @@ -6571,7 +6943,7 @@ dialogue to save the new template using a new template name.</p></div> <div class="paragraph"><p>Additional information about <em>Grantlee</em> can be found at <a href="http://www.grantlee.org/apidox/for_themers.html">here</a></p></div> </div> <div class="sect2"> -<h3 id="_grantlee_exported_variables">19.2. Grantlee exported variables</h3> +<h3 id="_grantlee_exported_variables">21.2. Grantlee exported variables</h3> <div class="paragraph"><p>Only a subset of the dive data is exported:</p></div> <div class="tableblock"> <table rules="all" @@ -6799,7 +7171,7 @@ cellspacing="0" cellpadding="4"> </div></div> </div> <div class="sect2"> -<h3 id="_defined_css_selectors">19.3. Defined CSS selectors</h3> +<h3 id="_defined_css_selectors">21.3. Defined CSS selectors</h3> <div class="paragraph"><p>As the dive profile is placed after rendering, <em>Subsurface</em> uses special <em>CSS</em> selectors to searche in the HTML output. The <em>CSS</em> selectors in the following table should be added.</p></div> <div class="tableblock"> @@ -6845,7 +7217,7 @@ in flow layout templates only (when data-numberofdives = 0)</p></td> </div> </div> <div class="sect2"> -<h3 id="_special_attributes">19.4. Special attributes</h3> +<h3 id="_special_attributes">21.4. Special attributes</h3> <div class="paragraph"><p>There are two ways of rendering- either rendering a specific number of dives in each page or make <em>Subsurface</em> try to fit as many dives as possible into one page (<em>flow</em> rendering).</p></div> <div class="paragraph"><p>The <strong>data-numberofdives</strong> data attribute is added to the body tag to set the rendering mode.</p></div> @@ -6883,10 +7255,10 @@ render as much dives as possible: </div> </div> <div class="sect1"> -<h2 id="_appendix_f_faqs">20. APPENDIX F: FAQs.</h2> +<h2 id="_appendix_f_faqs">22. APPENDIX F: FAQs.</h2> <div class="sectionbody"> <div class="sect2"> -<h3 id="S_APPENDIX_F">20.1. Subsurface appears to miscalculate gas consumption and SAC</h3> +<h3 id="S_APPENDIX_F">22.1. Subsurface appears to miscalculate gas consumption and SAC</h3> <div class="paragraph" id="SAC_CALCULATION"><p><em>Question</em>: I dived with a 12.2 l tank, starting with 220 bar and ending with 100 bar, and I calculate a different SAC compared what <em>Subsurface</em> calculates. Is <em>Subsurface</em> miscalculating?</p></div> <div class="paragraph"><p><em>Answer</em>: Not really. What happens is that <em>Subsurface</em> actually calculates gas @@ -6917,7 +7289,7 @@ starts becoming much more noticeable at high pressure. A 400 bar really does not contain twice as much air as a 200 bar one. At lower pressures, air acts pretty much like an ideal gas.</p></div> </div> <div class="sect2"> -<h3 id="_some_dive_profiles_have_time_discrepancies_with_the_recorded_samples_from_my_dive_computer_8230">20.2. Some dive profiles have time discrepancies with the recorded samples from my dive computer…</h3> +<h3 id="_some_dive_profiles_have_time_discrepancies_with_the_recorded_samples_from_my_dive_computer_8230">22.2. Some dive profiles have time discrepancies with the recorded samples from my dive computer…</h3> <div class="paragraph"><p><em>Subsurface</em> ends up ignoring surface time for many things (average depth, divetime, SAC, etc). <em>Question</em>: Why do dive durations in my dive computer differ from that given by <em>Subsurface</em>?</p></div> <div class="paragraph"><p><em>Answer</em>: For example, if you end up doing a weight check (deep enough to trigger the "dive started") @@ -6929,7 +7301,7 @@ you may stay in the water for a long time, but spend most of it at the surface. you don’t want that to count as some kind of long dive”.</p></div> </div> <div class="sect2"> -<h3 id="_some_dive_profiles_are_missing_from_the_download">20.3. Some dive profiles are missing from the download</h3> +<h3 id="_some_dive_profiles_are_missing_from_the_download">22.3. Some dive profiles are missing from the download</h3> <div class="paragraph" id="DC_HISTORY"><p><em>Question</em>: I cannot download all my dives, only the most recent ones, even though my dive computer’s manual states that it records history of e.g. 999 dives? @@ -6952,7 +7324,7 @@ cannot be salvaged after being overwritten by new dives.</p></div> <div id="footnotes"><hr /></div> <div id="footer"> <div id="footer-text"> -Last updated 2016-11-07 21:11:40 PST +Last updated 2017-01-15 11:35:43 PST </div> </div> </body> |