ADD: configxml.html: 'Sounds'. (#70)

UPD: copymove.html: A note about verification. UPD: help.html: A note about opening drives. UPD: multiarc.html: A note about multi-line content parsing. Other small fixes/changes.
doublecmd · Nov 30, 2024 · 0239eab · 0239eab
1 parent e39088c
commit 0239eab
Show file tree

Hide file tree

Showing 10 changed files with 55 additions and 5 deletions.
diff --git a/doc/en/configxml.html b/doc/en/configxml.html
@@ -199,6 +199,28 @@ <h2><a name="manualed">3. Options to change manually</a></h2>
             </td>
           </tr>
 
+          <tr>
+            <td class="cmdcell"><div class="firstcolumnaleft"><a name="Sounds">&lt;Sounds&gt;</a></div></td>
+            <td class="hintcell">
+              Enables sound notifications when file operations are finished. Possible contents of the <code>&lt;Sounds&gt;</code> tag in full:<br>
+            <pre>
+&lt;Sounds Duration="-1"&gt;
+  &lt;Copy&gt;C:\Windows\Media\Alarm01.wav&lt;/Copy&gt;
+  &lt;Move&gt;C:\Windows\Media\Alarm01.wav&lt;/Move&gt;
+  &lt;Wipe&gt;C:\Windows\Media\Alarm01.wav&lt;/Wipe&gt;
+  &lt;Delete&gt;C:\Windows\Media\Alarm01.wav&lt;/Delete&gt;
+  &lt;Split&gt;C:\Windows\Media\Alarm01.wav&lt;/Split&gt;
+  &lt;Combine&gt;C:\Windows\Media\Alarm01.wav&lt;/Combine&gt;
+&lt;/Sounds&gt;</pre>
+              <code>Duration</code> is the minimum time (in seconds) that a file operation should last. Additional values: 0&nbsp;&ndash; always on, -1 disables sound notifications.<br>
+              File operations: copy, move, wipe, delete files, split file and combine files. If a sound notification is not needed for some operation, just remove (or do not add) the corresponding line. <a href="variables.html#envvariables">Environment variables</a> are supported.<br>
+              Supported audio formats:<br>
+              - Windows (the <tt>sndPlaySoundW</tt> function from the Windows API): .wav.<br>
+              - macOS (the Core Audio API): .aac, .adts, .ac3, .caf, .mp3, .m4a and .mp4 (with AAC or ALAC), .wav.<br>
+              - Linux and other Unix-like systems: Double Commander can use the GStreamer library (primarily, <tt>libgstreamer-1.0.so.0</tt>) or the SDL2 library (<tt>libSDL2-2.0.so.0</tt>). GStreamer supports most popular audio formats, with SDL2 we can use only .wav. In Haiku, only SDL2 can be used.
+            </td>
+          </tr>
+
           <tr>
             <td colspan="2" class="subsection"><div class="subsection">from &lt;FileOperations&gt;&lt;Options&gt;:</div></td>
           </tr>
@@ -656,6 +678,7 @@ <h2><a name="index">4. Index</a></h2>
                 <a href="#Quality">Quality</a><br>
                 <a href="#RenameConfirmMouse">RenameConfirmMouse</a><br>
                 <a href="#ShowColonAfterDrive">ShowColonAfterDrive</a><br>
+                <a href="#Sounds">Sounds</a><br>
                 <a href="#SynEditMask">SynEditMask</a><br>
                 <a href="#SystemItemProperties">SystemItemProperties</a><br>
                 <a href="#TabSpaces">TabSpaces</a><br>

diff --git a/doc/en/copymove.html b/doc/en/copymove.html
@@ -57,7 +57,7 @@ <h2><a name="confirmation">1. Copy/move dialog window</a></h2>
         </ul>
         <p>The list of the following parameters will vary depending on the type of file operation and operating system family.</p>
         <ul>
-          <li><p><span class="italic">Verify</span>&nbsp;&ndash; If enabled, Double Commander will compare the source file and the copied file in the target directory: a byte-by-byte comparison (Windows) or BLAKE2 checksums (Linux and others). Double Commander will try to minimize the disk cache effects (if the file system does not support direct input/output, the program will report the verification failure). Keep in mind, this function significantly reduces the speed of the operation. Not available in macOS.</p></li>
+          <li><p><span class="italic">Verify</span>&nbsp;&ndash; If enabled, Double Commander will compare the source file and the copied file in the target directory: a byte-by-byte comparison (Windows) or BLAKE2 checksums (Linux and others). Double Commander will try to minimize the disk cache effects (if the file system does not support direct input/output, the program will report the verification failure). Keep in mind, this function significantly reduces the speed of the operation. Please note that each file will be read twice, so the total size of files in the progress bar will be doubled. Not available in macOS.</p></li>
           <li><p><span class="italic">Check free space</span>&nbsp;&ndash; Before copying the file, Double Commander will check if there is enough free disk space in the target directory.</p></li>
           <li><p><span class="italic">Reserve space</span>&nbsp;&ndash; If enabled, Double Commander will use pre-allocation of disk space, this will reduce the chances of file fragmentation. Also this is a faster way to create files. In Windows, Double Commander always reserves space. Does not work in Linux on partitions with FAT32 file system.</p></li>
           <li><p><span class="italic">Follow links</span>&nbsp;&ndash; If enabled, Double Commander will consider symbolic links to folders as regular folders and copy their contents; instead of file links, the target  files of this links will be copied. The indeterminate checkbox state (three-state): the program will ask each time what it should do.</p></li>

diff --git a/doc/en/help.html b/doc/en/help.html
@@ -410,7 +410,7 @@ <h2><a name="iface_toolbar">2.2. Button toolbar</a></h2>
       <div>
         <h2><a name="iface_drive_pane">2.3. Drives button bar</a></h2>
         <p class="figure"><img title="Drives button bar" alt="Drives button bar" src="images/imgDC/pic3.png" width="472" height="25"></p>
-        <p>The Drives button bar helps you to change the drive quickly with one mouse click. Middle mouse (mouse wheel) click will open the disk in a new tab in the active panel.</p>
+        <p>The Drives button bar helps you to change the drive quickly with one mouse click. Middle mouse (mouse wheel) click will open the disk in a new tab in the active panel. There are two ways to open a drive, see the description of the <a href="configuration.html#ConfigMisc">Always go to the root of a drive when changing drives</a> parameter.</p>
         <p>Right click shows the context menu that contains operations such as mount/unmount, format, etc. (depends on the OS and drive type).</p>
         <p>The last button is <a href="#cm_OpenVirtualFileSystemList">Open VFS list</a>.</p>
         <p class="navback"><a href="#topofpage">(back to top)</a></p>
@@ -423,6 +423,7 @@ <h2><a name="iface_drive_btn">2.4. Drives list</a></h2>
         <p>Internal commands are <tt><a name="cm_LeftOpenDrives">cm_LeftOpenDrives</a></tt> for left panel and <tt><a name="cm_RightOpenDrives">cm_RightOpenDrives</a></tt>&nbsp;&ndash; for right panel. Default shortcuts: <kbd>Alt+F1</kbd> and <kbd>Alt+F2</kbd>, but they won't work in most Linux Desktop Environments (just open the <a href="configuration.html#ConfigHotKeys">Keys&nbsp;&gt; Hot keys</a> settings section and replace them).</p>
         <p class="figure"><img class="largeimage" title="Drives list" alt="Drives list" src="images/imgDC/pic5.png" width="292" height="152"></p>
         <p>Internal command <tt>cm_SrcOpenDrives</tt> will show this menu for active panel.</p>
+        <p>There are two ways to open a drive, see the description of the <a href="configuration.html#ConfigMisc">Always go to the root of a drive when changing drives</a> parameter.</p>
         <p>Additional navigation buttons:</p>
         <p><tt><a name="btn_dirlist">"*"</a></tt>&nbsp;&ndash; shows the bookmarks hotlist, see the dedicated <a href="directoryhotlist.html">Directory Hotlist</a> help page for details;</p>
         <p><tt>"\"</tt> or <tt>"/"</tt>&nbsp;&ndash; go to the root of the current drive (Windows) or to the file system root (Linux and other Unix-like systems). Exceptions:</p>

diff --git a/doc/en/images/imgDC/syncdirscomp.png b/doc/en/images/imgDC/syncdirscomp.png
diff --git a/doc/en/multiarc.html b/doc/en/multiarc.html
@@ -274,6 +274,7 @@ <h2><a name="standardparsing">4.5.3. Standard syntax for parsing</a></h2>
           <tr><td class="varcell"><div class="firstcolumnaleft">*</div></td><td class="hintcell">skip until first space or end of line</td></tr>
           <tr><td class="varcell"><div class="firstcolumnaleft">+</div></td><td class="hintcell">for name field at line end: use all chars until the end of the line</td></tr>
         </table>
+        <p>If the archiver displays information about each file using more than one line, we must specify the corresponding number of lines to parse the contents (Double Commander supports up to 50 lines).</p>
         <p class="navback"><a href="#topofpage">(back to top)</a></p>
       </div>
 

diff --git a/doc/ru/configxml.html b/doc/ru/configxml.html
@@ -197,6 +197,28 @@ <h2><a name="manualed">3. Параметры, изменяемые вручну
             </td>
           </tr>
 
+          <tr>
+            <td class="cmdcell"><div class="firstcolumnaleft"><a name="Sounds">&lt;Sounds&gt;</a></div></td>
+            <td class="hintcell">
+              Включает звуковые уведомления при завершении файловых операций. Возможное содержимое тега <code>&lt;Sounds&gt;</code> полностью:<br>
+              <pre>
+&lt;Sounds Duration="-1"&gt;
+  &lt;Copy&gt;C:\Windows\Media\Alarm01.wav&lt;/Copy&gt;
+  &lt;Move&gt;C:\Windows\Media\Alarm01.wav&lt;/Move&gt;
+  &lt;Wipe&gt;C:\Windows\Media\Alarm01.wav&lt;/Wipe&gt;
+  &lt;Delete&gt;C:\Windows\Media\Alarm01.wav&lt;/Delete&gt;
+  &lt;Split&gt;C:\Windows\Media\Alarm01.wav&lt;/Split&gt;
+  &lt;Combine&gt;C:\Windows\Media\Alarm01.wav&lt;/Combine&gt;
+&lt;/Sounds&gt;</pre>
+              <code>Duration</code>&nbsp;&ndash; минимальное время (в секундах), которое должна продолжаться файловая операция. Дополнительные значения: 0&nbsp;&ndash; включено всегда, -1 отключает звуковые уведомления.<br>
+              Файловые операции: копировать, переместить, стереть, удалить файлы, разрезать файл и собрать файлы. Если для какой-то операции не нужно звуковое оповещение, то просто уберите (или не добавляйте) соответствующую строку. Поддерживаются <a href="variables.html#envvariables">переменные окружения</a>.<br>
+              Поддерживаемые форматы аудио:<br>
+              - Windows (функция <tt>sndPlaySoundW</tt> из Windows API): .wav.<br>
+              - macOS (Core Audio API): .aac, .adts, .ac3, .caf, .mp3, .m4a и .mp4 (с AAC или ALAC), .wav.<br>
+              - Linux и другие Unix-подобные системы: Double Commander может использовать библиотеку GStreamer (в первую очередь, <tt>libgstreamer-1.0.so.0</tt>) или библиотеку SDL2 (<tt>libSDL2-2.0.so.0</tt>). GStreamer поддерживает большинство популярных форматов аудио, с SDL2 мы можем использовать только .wav. В Haiku доступно использование только SDL2.
+            </td>
+          </tr>
+
           <tr>
             <td colspan="2" class="subsection"><div class="subsection">в &lt;FileOperations&gt;&lt;Options&gt;:</div></td>
           </tr>
@@ -654,6 +676,7 @@ <h2><a name="index">4. Индекс</a></h2>
                 <a href="#Quality">Quality</a><br>
                 <a href="#RenameConfirmMouse">RenameConfirmMouse</a><br>
                 <a href="#ShowColonAfterDrive">ShowColonAfterDrive</a><br>
+                <a href="#Sounds">Sounds</a><br>
                 <a href="#SynEditMask">SynEditMask</a><br>
                 <a href="#SystemItemProperties">SystemItemProperties</a><br>
                 <a href="#TabSpaces">TabSpaces</a><br>

diff --git a/doc/ru/copymove.html b/doc/ru/copymove.html
@@ -57,7 +57,7 @@ <h2><a name="confirmation">1. Диалоговое окно копировани
         </ul>
         <p>Список следующих параметров будет различаться в зависимости от типа файловой операции и семейства операционных систем.</p>
         <ul>
-          <li><p><span class="italic">Проверить после завершения</span>&nbsp;&ndash; Если отмечено, Double Commander сравнит исходный файл и скопированный файл в целевом каталоге: побайтовое сравнение (Windows) или контрольные суммы BLAKE2 (Linux и другие). Double Commander попытается свести к минимуму эффекты дискового кэша (если файловая система не поддерживает прямой ввод-вывод, программа сообщит о неудаче проверки). Имейте в виду, эта функция заметно снижает скорость операции. Недоступно в macOS.</p></li>
+          <li><p><span class="italic">Проверить после завершения</span>&nbsp;&ndash; Если отмечено, Double Commander сравнит исходный файл и скопированный файл в целевом каталоге: побайтовое сравнение (Windows) или контрольные суммы BLAKE2 (Linux и другие). Double Commander попытается свести к минимуму эффекты дискового кэша (если файловая система не поддерживает прямой ввод-вывод, программа сообщит о неудаче проверки). Имейте в виду, эта функция заметно снижает скорость операции. Обратите внимание, каждый файл будет прочитан дважды, поэтому общий размер файлов в полосе прогресса операции будет увеличен в два раза. Недоступно в macOS.</p></li>
           <li><p><span class="italic">Проверять свободное место</span>&nbsp;&ndash; Перед копированием файла Double Commander проверит, достаточно ли свободного места на диске в целевом каталоге.</p></li>
           <li><p><span class="italic">Резервировать место</span>&nbsp;&ndash; Если отмечено, Double Commander будет использовать предварительное выделение дискового пространства, это снизит вероятность фрагментации файла. Также это более быстрый способ создания файлов. В Windows Double Commander всегда резервирует место. Не работает в Linux на разделах с файловой системой FAT32.</p></li>
           <li><p><span class="italic">Следовать ссылкам</span>&nbsp;&ndash; Если отмечено, Double Commander будет считать символьные ссылки на папки обычными папками и копировать их содержимое; вместо ссылок на файл будут скопированы файлы, на которые они указывают. Неопределённое (третье) состояние флажка: программа будет каждый раз спрашивать, что она должна делать.</p></li>

diff --git a/doc/ru/help.html b/doc/ru/help.html
@@ -410,7 +410,7 @@ <h2><a name="iface_toolbar">2.2. Панель инструментов</a></h2>
       <div>
         <h2><a name="iface_drive_pane">2.3. Панель кнопок дисков</a></h2>
         <p class="figure"><img title="Панель кнопок дисков" alt="Панель кнопок дисков" src="images/imgDC/ris3.png" width="472" height="25"></p>
-        <p>Кнопки дисков позволяют быстро сменить диск просто нажав на соответствующую кнопку. Щелчок средней кнопки мыши (колесо мыши) откроет диск в новой вкладке активной панели.</p>
+        <p>Кнопки дисков позволяют быстро сменить диск просто нажав на соответствующую кнопку. Щелчок средней кнопки мыши (колесо мыши) откроет диск в новой вкладке активной панели. Доступно два способа открытия диска, смотрите описание параметра <a href="configuration.html#ConfigMisc">При смене диска всегда переходить в корневой каталог</a>.</p>
         <p>Щелчок правой кнопкой мыши вызывает контекстное меню, из которого можно произвести операции монтирования/размонтирования, форматирование и прочее (зависит от используемой системы и типа диска).</p>
         <p>Последняя кнопка&nbsp;&ndash; <a href="#cm_OpenVirtualFileSystemList">Открыть список VFS</a>.</p>
         <p class="navback"><a href="#topofpage">(наверх)</a></p>
@@ -423,6 +423,7 @@ <h2><a name="iface_drive_btn">2.4. Список дисков</a></h2>
         <p>Внутренняя команда <tt><a name="cm_LeftOpenDrives">cm_LeftOpenDrives</a></tt> для левой панели и <tt><a name="cm_RightOpenDrives">cm_RightOpenDrives</a></tt>&nbsp;&ndash; для правой. Сочетания клавиш по умолчанию: <kbd>Alt+F1</kbd> и <kbd>Alt+F2</kbd>, но они не работают в большинстве сред рабочего стола Linux, так как уже заняты (просто откройте раздел настроек <a href="configuration.html#ConfigHotKeys">Клавиши&nbsp;&gt; Горячие клавиши</a> и замените их).</p>
         <p class="figure"><img class="largeimage" title="Список дисков" alt="Список дисков" src="images/imgDC/ris5.png" width="330" height="152"></p>
         <p>Внутренняя команда <tt>cm_SrcOpenDrives</tt> покажет это меню для активной панели.</p>
+        <p>Доступно два способа открытия диска, смотрите описание параметра <a href="configuration.html#ConfigMisc">При смене диска всегда переходить в корневой каталог</a>.</p>
         <p>Дополнительные кнопки навигации:</p>
         <p><tt><a name="btn_dirlist">"*"</a></tt>&nbsp;&ndash; показать избранные каталоги, подробнее смотрите на странице <a href="directoryhotlist.html">Избранные каталоги</a>;</p>
         <p><tt>"\"</tt> или <tt>"/"</tt>&nbsp;&ndash; перейти в корень текущего диска (Windows) или в корень файловой системы (Linux и другие Unix-подобные системы). Исключения:</p>

diff --git a/doc/ru/images/imgDC/syncdirscomp.png b/doc/ru/images/imgDC/syncdirscomp.png