Skip to content

Commit

Permalink
alpha: ADD: cmds.html, faq.html, shortcuts.html: 'cm_MapNetworkDrive'…
Browse files Browse the repository at this point in the history
… and some related changes/updates.

alpha: ADD: configxml.html: 'MaxStringItems', 'Sounds'.
alpha: ADD: help.html, shortcuts.html: Use up/down arrowa to rename next/previous file.
alpha: ADD: help.html: 'Calculate check sum': XXH128.
alpha: ADD: help.html: Create directory: Option to disable auto-completion.
alpha: ADD: lua.html: DC.ExpandVar, DC.GetPluginField, DC.GoToFile, SysUtils.ExpandEnv, SysUtils.FileSetTime, SysUtils.GetFileProperty, SysUtils.RemoveDirectory.
alpha: ADD: multiarc.html: 'AskHistoryN', 'FallBackArchivers' and 'IgnoreStringN' (to the 'Additional settings' subsection); 'Show as normal files'.
alpha: UPD: configuration.html, multiarc.html: The 'c' expression now works.
alpha: UPD: copymove.html: Support verify after copy in macOS (experimentally).
UPD: Screenshots.
Other small fixes/changes.
  • Loading branch information
Skif-off committed Oct 12, 2024
1 parent bb9908c commit f5864f0
Show file tree
Hide file tree
Showing 27 changed files with 338 additions and 30 deletions.
12 changes: 12 additions & 0 deletions doc/en/cmds.html
Original file line number Diff line number Diff line change
Expand Up @@ -1110,6 +1110,18 @@ <h2><a name="catnetwork">2.6. Network</a></h2>
<div class="cmdname"><a name="cm_CopyNetNamesToClip">cm_CopyNetNamesToClip</a></div></td>
<td class="cmdhintcell">Windows only: copy names with UNC path.</td>
</tr>
<tr>
<td class="cmdcell"><img class="IntCmdImage" title="cm_MapNetworkDrive" alt="cm_MapNetworkDrive" src="../../pixmaps/dctheme/32x32/actions/cm_mapnetworkdrive.png">
<div class="cmdname"><a name="cm_MapNetworkDrive">cm_MapNetworkDrive</a><span class="versionref"><sup>(Alpha version)</sup></span></div>
<div class="shrtctkey">Ctrl+K</div></td>
<td class="cmdhintcell">This command allows to connect network devices, the behavior depends on the operating system:
<ul>
<li>Windows: will call the Windows system dialog to connect network drives.</li>
<li>macOS: similar to the "Connect to Server" command in Finder.</li>
<li>Linux and other Unix-like systems: Double Commander will prompt to specify the path, you can use GVfs paths (see <a href="faq.html#gvfs">FAQ</a> for more details) or specify a local directory. Thus, the result of this command is similar to the <a href="#cm_EditPath">cm_EditPath</a> command.</li>
</ul>
</td>
</tr>
</table>
<p class="navback"><a href="#topofpage">(back to top)</a></p>
</div>
Expand Down
8 changes: 4 additions & 4 deletions doc/en/configuration.html
Original file line number Diff line number Diff line change
Expand Up @@ -636,7 +636,7 @@ <h2><a name="settings">2. Configuration</a></h2>
<li><p><tt>GETFILEOWNER</tt>&nbsp;&ndash; displays the owner of the file.</p></li>
<li><p><tt>GETFILELINKTO</tt>&nbsp;&ndash; displays the path and file, that is, what is linked with this symlink.</p></li>
<li><p><tt>GETFILETYPE</tt>&nbsp;&ndash; file type (as in Windows Explorer or MIME-type).</p></li>
<li><p><tt>GETFILECOMMENT</tt>&nbsp;&ndash; file or directory description (comment) from <tt>descript.ion</tt> (see details <a href="help.html#cm_EditComment">here</a>).</p></li>
<li><p><tt>GETFILECOMMENT</tt>&nbsp;&ndash; file or directory description (comment) from <tt>descript.ion</tt> (see details <a href="help.html#cm_EditComment">here</a>). This field can also be used inside archives (if the archive format supports saving file descriptions and the corresponding <a href="multiarc.html#archivers">external archiver</a> is configured to receive them).</p></li>
<li><p><tt>GETFILECOMPRESSEDSIZE</tt>&nbsp;&ndash; compressed file size (real size if using NTFS compression).</p></li>
</ul>
<p><span class="italic">Move</span>&nbsp;&ndash; allows to move lines (which equates to reordering the columns). Click twice in the Move box and you will see a type of spinner appear, clicking on the upper part moves the line up (column moves left).</p>
Expand Down Expand Up @@ -868,8 +868,8 @@ <h2><a name="settings">2. Configuration</a></h2>
<li><p><span class="italic">Command line history</span>&nbsp;&ndash; Commands that were used at the <a href="help.html#iface_path">command line</a>.</p></li>
<li><p><span class="italic">File mask history</span>&nbsp;&ndash; Double Commander saves a general history of used file masks for several tools: find files, filters in <a href="syncdirs.html">directory synchronization</a> and <a href="help.html#cm_ExtractFiles">archive unpacking</a>, commands for <a href="help.html#cm_MarkPlus">selecting and deselecting a group of files</a>.</p></li>
</ul>
<p>The maximum number of entries in history is limited to 50.</p>
<p>Note about the history of visited directories: During the session, Double Commander stores up to 255 visited directories in memory (however, when the program is closed, only the last 50 entries will be saved). You can change the number of history entries in the popup menu when calling the <a href="cmds.html#cm_DirHistory">cm_DirHistory</a> command (default value is 30, see the <code>Count</code> attribute in the <a href="configxml.html">&lt;DirHistory&gt;</a> tag), but when using the <a href="#ConfigTreeMenu">Tree View Menu</a>, all available history will be shown.</p>
<p>The maximum number of entries in history is limited to 50 by default (see the <code>MaxStringItems</code> attribute in the <a href="configxml.html">&lt;History&gt;</a> tag).</p>
<p>Note about the history of visited directories: During the session, Double Commander stores up to 255 visited directories in memory, however, when the program is closed, the number of saved entries will be limited to the <code>MaxStringItems</code> value. You can change the number of history entries in the popup menu when calling the <a href="cmds.html#cm_DirHistory">cm_DirHistory</a> command (default value is 30, see the <code>Count</code> attribute in the <a href="configxml.html">&lt;DirHistory&gt;</a> tag), but when using the <a href="#ConfigTreeMenu">Tree View Menu</a>, all available history will be shown.</p>
<p>Note: Search templates are not related to the history and are saved separately (in the <tt>doublecmd.xml</tt> configuration file). To manage the list of templates, you can use the <a href="findfiles.html#templates">file search</a> tool.</p>
<p>You can choose how the list of settings sections will look:</p>
<ul>
Expand Down Expand Up @@ -1072,7 +1072,7 @@ <h2><a name="settings">2. Configuration</a></h2>
</ul>
<p>"View" actions with the <tt>{!DC-VIEWER}</tt> macro will be taken into account for <a href="viewer.html#quick">quick viewing</a>, other macros and commands will be ignored.</p>
<p><tt>{!TERMSTAYOPEN}</tt> and <tt>{!TERMANDCLOSE}</tt> have been added for unification and the ability to use the variables <a href="variables.html#executeterm">%t0 and %t1</a>, <tt>{!SHELL}</tt> has been kept for backwards compatibility.</p>
<p>As a command, you can use the <a href="cmds.html">internal commands</a> of Double Commander. The parameters of the internal commands are specified one per line, so you can specify only one here. Also, using the internal command <a href="cmds.html#cm_ExecuteScript">cm_ExecuteScript</a>, you can run <a href="lua.html">Lua scripts</a>, in this case you can get the names of the selected files using <a href="cmds.html#cm_CopyFullNamesToClip">cm_CopyFullNamesToClip</a> or <a href="cmds.html#cm_SaveSelectionToFile">cm_SaveSelectionToFile</a>.</p>
<p>As a command, you can use the <a href="cmds.html">internal commands</a> of Double Commander. The parameters of the internal commands are specified one per line, so you can specify only one here. Also, using the internal command <a href="cmds.html#cm_ExecuteScript">cm_ExecuteScript</a>, you can run <a href="lua.html">Lua scripts</a>, in this case you can get the names of the selected files using internal commands (<a href="cmds.html#cm_CopyFullNamesToClip">cm_CopyFullNamesToClip</a> or <a href="cmds.html#cm_SaveSelectionToFile">cm_SaveSelectionToFile</a>) or the <a href="lua.html#dc_expandvar">DC.ExpandVar</a><span class="versionref"><sup>(Alpha version)</sup></span> function.</p>
<p><span class="italic">Parameters</span>&nbsp;&ndash; command parameters including variables:</p>
<ul>
<li><p>any variable from <a href="variables.html">"percent" variables</a>.</p></li>
Expand Down
27 changes: 27 additions & 0 deletions doc/en/configxml.html
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,28 @@ <h2><a name="manualed">3. Options to change manually</a></h2>
</td>
</tr>

<tr>
<td class="cmdcell"><div class="firstcolumnaleft">&lt;Sounds&gt;<span class="versionref"><sup>(Alpha version)</sup></span><br><small>from &lt;FileOperations&gt;</small></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="10"&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 (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 are supported</a>.<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 class="cmdcell"><div class="firstcolumnaleft">&lt;CopyAttributes&gt;<br><small>from &lt;FileOperations&gt;&lt;Options&gt;</small></div></td>
<td class="hintcell">
Expand Down Expand Up @@ -342,6 +364,11 @@ <h2><a name="manualed">3. Options to change manually</a></h2>
<td colspan="2"></td>
</tr>

<tr>
<td class="cmdcell"><div class="firstcolumnaleft">Attribute <i>MaxStringItems</i><span class="versionref"><sup>(Alpha version)</sup></span><br><small>from &lt;History&gt;</small></div></td>
<td class="hintcell">The <code>MaxStringItems</code> attribute allows to specify the maximum number of entries in the <a href="configuration.html#ConfigDC">saved history</a>. Default value is 50.</td>
</tr>

<tr>
<td class="cmdcell"><div class="firstcolumnaleft">Attribute <i>Count</i><br><small>from &lt;History&gt;&lt;DirHistory&gt;</small></div></td>
<td class="hintcell">
Expand Down
2 changes: 1 addition & 1 deletion doc/en/copymove.html
Original file line number Diff line number Diff line change
Expand Up @@ -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. In macOS, this feature is available experimentally.<span class="versionref"><sup>(Alpha version)</sup></span></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>
Expand Down
2 changes: 1 addition & 1 deletion doc/en/faq.html
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ <h2>2. Issues related to GNU/Linux</h2>
<p>First, packages <tt>gvfs</tt>, <tt>gvfs-backends</tt> and <tt>gvfs-fuse</tt> should be installed.
Keep in mind that some distributions have not packages <tt>gvfs-backends</tt> and <tt>gvfs-fuse</tt>,
because they are part of package <tt>gvfs</tt>, or it can be several packages with names <tt>gvfs-backends-*</tt> or <tt>gvfs-*</tt>.</p>
<p>Now insert GVfs path in the address bar: click by right mouse button at address bar to edit it (or call internal command <tt>cm_EditPath</tt>).</p>
<p>Now insert GVfs path in the address bar: click by right mouse button at address bar to edit it (or call internal command <tt>cm_EditPath</tt>). Alternatively, you can use the internal command <a href="cmds.html#cm_MapNetworkDrive">cm_MapNetworkDrive</a>.<span class="versionref"><sup>(Alpha version)</sup></span></p>
<p>For example, access to</p>
<ul>
<li>FTP: <code>ftp://ftpuser@ftpserver</code></li>
Expand Down
9 changes: 6 additions & 3 deletions doc/en/help.html
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,7 @@ <h2><a name="mnu_file">2.1.1. "Files"</a></h2>

<p><span class="bold">Create Directory</span> (internal command <tt>cm_MakeDir</tt>)&nbsp;&ndash; creates a new subdirectory in the current directory. The file name (without extension) or directory name under the cursor will be offered, this is useful for creating multiple directories with similar names. You can also create several subdirectories in one operation, just separate the subdrectories with the directory separator (in Unix/Linux system it will be "/" and in Windows it will be "\").</p>
<p class="figure"><img class="largeimage" title="Create Directory" alt="Create Directory" src="images/imgDC/pic55.png" width="352" height="144"></p>
<p>The button with an arrow opens the history of the entered names. The button to the right of the input field allows to enable or disable auto-completion from the directory creation history.<span class="versionref"><sup>(Alpha version)</sup></span></p>
<p>If <span class="italic">Extended syntax</span> is enabled, the <code>&lt;[]</code> template can be used to insert the current date/time: inside square brackets you can use <a href="configuration.html#dt_format">date and time formatting characters</a> and any characters allowed for filenames.</p>

<p><span class="bold">Create Shortcut</span> (Windows only)&nbsp;&ndash; Double Commander creates a shortcut (Microsoft Windows .lnk file) to the file under the cursor and places it in the folder opened in the opposite panel.</p>
Expand Down Expand Up @@ -182,7 +183,7 @@ <h2><a name="mnu_file">2.1.1. "Files"</a></h2>
<p>The action of the <span class="italic">Configure</span> button depends on the selected archiver:</p>
<ul>
<li><p>packer plugins (WCX): opens the plugin's own settings window (if selected plugin supports this feature);</p></li>
<li><p>external archivers: opens a window with an input field for additional archiver parameters.</p></li>
<li><p>external archivers: opens a window with an input field for additional archiver parameters. Double Commander automatically saves the entered parameter string, the button with an arrow will open the list of previously saved ones (see description of <a href="multiarc.html#aconfig">AskHistory</a>).<span class="versionref"><sup>(Alpha version)</sup></span></p></li>
</ul>
<p>Also we can unpack files via <a name="cm_ExtractFiles"><span class="bold">Extract Files</span></a> (internal command <tt>cm_ExtractFiles</tt>). The same dialog is called when you copy files from the archive.</p>
<p class="figure"><img class="largeimage" title="Unpack" alt="Unpack" src="images/imgDC/pic23.png" width="480" height="246"></p>
Expand Down Expand Up @@ -213,7 +214,8 @@ <h2><a name="mnu_file">2.1.1. "Files"</a></h2>

<p>Item <a name="cm_CheckSumCalc"><span class="bold">Calculate check sum...</span></a> (internal command <tt>cm_CheckSumCalc</tt>) is used to calculate the <a href="https://en.wikipedia.org/wiki/Checksum" target="_blank">checksum</a> to check files integrity. The following checksums are available:
BLAKE2 (BLAKE2s, BLAKE2sp, BLAKE2b, BLAKE2bp), BLAKE3, CRC32, HAVAL, MD4, MD5, RIPEMD128, RIPEMD160, SFV, SHA,
SHA2 (digest sizes 224, 256, 384 or 512 bits), SHA3 (digest sizes 224, 256, 384 or 512 bits), Tiger/192.</p>
SHA2 (digest sizes 224, 256, 384 or 512 bits), SHA3 (digest sizes 224, 256, 384 or 512 bits), Tiger/192,
XXH128<span class="versionref"><sup>(Alpha version)</sup></span> (XXH3 with 128 bit digest size).</p>
<p class="figure"><img class="largeimage" title="Calculate checksum" alt="Calculate checksum" src="images/imgDC/pic26.png" width="402" height="432"></p>
<p><span class="italic">Save checksum file(s) to:</span>&nbsp;&ndash; line specifies name and path to the calculated checksum.</p>
<p><span class="italic">Create separate checksum files for each file</span>&nbsp;&ndash; if checksum calculates for multiple files, this option allows to create separate checksum files for each target file.</p>
Expand Down Expand Up @@ -583,7 +585,8 @@ <h2><a name="iface_files">2.8. File Panels</a></h2>
<p><a name="rename_files"><span class="bold">Renaming files</span></a></p>
<p>Double Commander allows to rename files directly in the file panel. There are several ways to call this operation: the internal command <tt>cm_RenameOnly</tt> (<kbd>F2</kbd> or <kbd>Shift+F6</kbd> by default), the <a href="configuration.html#ConfigViewEx">left mouse click</a> or the corresponding item in the right mouse button menu.</p>
<p>By default, Double Commander will select the file name completely, but you can <a href="configuration.html#ConfigOperations">enable</a> file name selecting without an extension. Also, repeated hotkey presses allow to select the file name in parts, the following characters are used as a separator: space, hyphen underscore and period. Folder names are always selected completely.</p>
<p>To confirm the change in the name, use the <kbd>Enter</kbd> key or the rename confirmation button to the right of the edit field. To cancel unconfirmed changes (to exit editing mode), use the <kbd>Esc</kbd> key or the mouse click outside the edit field. You can use a mouse click outside the edit field to confirm the renaming (as in Windows Explorer), see the description of <a href="configxml.html">RenameConfirmMouse</a>.</p>
<p>To confirm the change in the name, use the <kbd>Enter</kbd> key or the rename confirmation button to the right of the edit field. To cancel unconfirmed changes (to exit editing mode), use the <kbd>Esc</kbd> key or the mouse click outside the edit field. You can use a mouse click outside the edit field to confirm the renaming (as in Windows Explorer), see the description of <a href="configxml.html">&lt;RenameConfirmMouse&gt;</a>.</p>
<p>Using the up and down arrows, you can rename several files sequentially: the new file name will be automatically saved when you go to edit the name of the next or previous file. To exit this mode, use the methods described above to confirm or cancel the operation.<span class="versionref"><sup>(Alpha version)</sup></span></p>
<p>For group renaming files, the <a href="multirename.html">appropriate tool</a> is available.</p>
<p class="navback"><a href="#topofpage">(back to top)</a></p>
</div>
Expand Down
Binary file modified doc/en/images/imgDC/archiveimg3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/en/images/imgDC/archiveimg5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/en/images/imgDC/pic55.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit f5864f0

Please sign in to comment.