Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions doc/en/READ_ME.txt
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
General instructions and convention about HTML help file of DC
General instructions and conventions about HTML help file of DC
==============================================================

- When using a link to something external to Double Commander help, set the target to be a new window using target="_blank" like in this example:
<a title="Double Commander Home Page" href="https://doublecmd.sourceforge.io/" target="_blank">Homepage</a>

- To be more friendly with the user, to make us as the same level as the user, let's talk using "WE" instead of "YOU".
The user will feel that we're working together.
(By tradition, for all sections except "2.1. Basic Help", "2.2. Configuration" and "2.3. Keyboard layout".)

- DO NOT USE POINT NUMBER IN HTML FILENAME.
Just name the file based on what it describes and assume we will not rename it.
Expand All @@ -17,8 +18,10 @@ Keep the section numbers for the text inside page and NEVER INSIDE A LINK.

- If you want to add a link to the FAQ, do not use the question number, because it may be changed in the future.

- If you want to add a description of a feature that is currently only available in the alpha version (development version), then add a special label:
- If you want to add a description of a feature that is currently only available in the alpha version (development version) or in the beta version (usually the first versions of the new major release), then add a special label:
<span class="versionref"><sup>(Alpha version)</sup></span>
or
<span class="versionref"><sup>(Beta version)</sup></span>
Don't forget to delete after release.


Expand Down
2 changes: 1 addition & 1 deletion doc/en/cmds.html
Original file line number Diff line number Diff line change
Expand Up @@ -1134,7 +1134,7 @@ <h2><a name="catmiscellaneous">2.7. Miscellaneous</a></h2>
<tr>
<td class="cmdcell"><img class="IntCmdImage" title="cm_LoadList" alt="cm_LoadList" src="../../pixmaps/dctheme/32x32/actions/cm_loadlist.png">
<div class="cmdname"><a name="cm_LoadList">cm_LoadList</a><span class="versionref"><sup>(Beta version)</sup></span></div></td>
<td class="cmdhintcell">Load list of files/folders from the specified text file.<br>
<td class="cmdhintcell">Load list of files/folders from the specified text file (plain text file containing full file names, one per line).<br>
<br>
<table class="innercmddesc">
<tr class="rowinnerdesc">
Expand Down
34 changes: 31 additions & 3 deletions doc/en/configuration.html
Original file line number Diff line number Diff line change
Expand Up @@ -304,9 +304,37 @@ <h2><a name="settings">2. Configuration</a></h2>
<p>In line <span class="italic">Category attributes</span> you can put file attributes, and DC will match any files which have matching attributes (not available if using a search template). File attributes are specified by the following templates:</p>
<ul>
<li><p>Windows: [<code>d</code> or <code>l</code>]<code>rahs</code>[<code>c</code> or <code>e</code>]<code>tp</code></p></li>
<li><p>Linux: [<code>b</code>, <code>c</code>, <code>d</code>, <code>f</code>, <code>l</code>, <code>r</code> or <code>s</code>]<code>rwxrwxrwx</code></p></li>
<li><p>Unix/Linux: [<code>b</code>, <code>c</code>, <code>d</code>, <code>f</code>, <code>l</code> or <code>s</code>]<code>rwxrwxrwx</code></p></li>
</ul>
<p>See the description of this values <a href="findfiles.html#attributes">here</a>. If attribute should not be set, it must be replaced with the "-" symbol, unnecessary attributes should be hidden: symbol "*" means match any number of characters, symbol "?" means any one character. For example, <code>?r*</code> (Windows) or <code>?r-*</code> (Linux) will find all read-only files and folders.</p>
<p>i.e. the template must match the attribute text string in the file list. Description of values:</p>
<table>
<tr class="rowcategorytitle"><th colspan="2">Attributes in Windows</th></tr>
<tr class="rowsubtitle"><th class="namecolumn">Attribute letter</th><th class="categorydesccolumn">What it stands for</th></tr>
<tr><td class="varcell"><div class="firstcolumnaleft">a</div></td><td class="hintcell">archive</td></tr>
<tr><td class="varcell"><div class="firstcolumnaleft">c</div></td><td class="hintcell">compressed (NTFS compression)</td></tr>
<tr><td class="varcell"><div class="firstcolumnaleft">d</div></td><td class="hintcell">directory</td></tr>
<tr><td class="varcell"><div class="firstcolumnaleft">e</div></td><td class="hintcell">encrypted (EFS encryption)</td></tr>
<tr><td class="varcell"><div class="firstcolumnaleft">h</div></td><td class="hintcell">hidden</td></tr>
<tr><td class="varcell"><div class="firstcolumnaleft">l</div></td><td class="hintcell">symlink</td></tr>
<tr><td class="varcell"><div class="firstcolumnaleft">p</div></td><td class="hintcell">sparse</td></tr>
<tr><td class="varcell"><div class="firstcolumnaleft">r</div></td><td class="hintcell">read only</td></tr>
<tr><td class="varcell"><div class="firstcolumnaleft">s</div></td><td class="hintcell">system</td></tr>
<tr><td class="varcell"><div class="firstcolumnaleft">t</div></td><td class="hintcell">temporary</td></tr>
</table>
<br>
<table>
<tr class="rowcategorytitle"><th colspan="2">Attributes in Unix/Linux (File Types)</th></tr>
<tr class="rowsubtitle"><th class="namecolumn">File Types letters</th><th class="categorydesccolumn">What it stands for</th></tr>
<tr><td class="varcell"><div class="firstcolumnaleft">b</div></td><td class="hintcell">block</td></tr>
<tr><td class="varcell"><div class="firstcolumnaleft">c</div></td><td class="hintcell">character</td></tr>
<tr><td class="varcell"><div class="firstcolumnaleft">d</div></td><td class="hintcell">directory</td></tr>
<tr><td class="varcell"><div class="firstcolumnaleft">f</div></td><td class="hintcell">fifo</td></tr>
<tr><td class="varcell"><div class="firstcolumnaleft">l</div></td><td class="hintcell">symlink</td></tr>
<tr><td class="varcell"><div class="firstcolumnaleft">s</div></td><td class="hintcell">socket</td></tr>
</table>
<br>
<p>The second part of the Unix/Linux template displays permissions: read (r), write (w), execute (x). The values are grouped in groups of three in the following order: user (owner), user's group, all others.</p>
<p>If attribute should not be set, it must be replaced with the "-" symbol, unnecessary attributes should be hidden: symbol "*" means match any number of characters, symbol "?" means any one character. For example, <code>?r*</code> (Windows) or <code>?r-*</code> (Linux) will find all read-only files and folders.</p>
<p>You can use a color from the list or specify yours using the "&gt;&gt;" button.</p>
<p>Do not forget to click "Apply" button after customization.</p>
<p>Rules are applied strictly in reverse order: a rule higher in the list will overlap any rule below.</p>
Expand Down Expand Up @@ -568,7 +596,7 @@ <h2><a name="settings">2. Configuration</a></h2>
<li><p><tt>GETFILECREATIONTIME</tt>&nbsp;&ndash; file or directory creation date (does not work in Linux/BSD, POSIX limitation).</p></li>
<li><p><tt>GETFILELASTACCESSTIME</tt>&nbsp;&ndash; file or directory last access date.</p></li>
<li><p><tt>GETFILECHANGETIME</tt>&nbsp;&ndash; file or directory status change date.</p></li>
<li><p><tt>GETFILEATTR</tt>&nbsp;&ndash; file or directory attributes. You can choose a string or numeric (octal) value. In Windows, an octal value can be used if Unix attributes are displayed in the file panel (for example, with the FTP plugin).</p></li>
<li><p><tt>GETFILEATTR</tt>&nbsp;&ndash; file or directory attributes. You can choose a string or numeric (octal) value. In Windows, an octal value can be used if Unix attributes are displayed in the file panel (for example, with the FTP plugin). For a detailed description of the string value, see <a href="#ConfigColorFiles">here</a>.</p></li>
<li><p><tt>GETFILEPATH</tt>&nbsp;&ndash; path to the current item. Uses: usually, for search results.</p></li>
<li><p><tt>GETFILEGROUP</tt>&nbsp;&ndash; displays the group of the file.</p></li>
<li><p><tt>GETFILEOWNER</tt>&nbsp;&ndash; displays the owner of the file.</p></li>
Expand Down
2 changes: 1 addition & 1 deletion doc/en/configxml.html
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ <h2><a name="manualed">3. Options to change manually</a></h2>
<td class="cmdcell"><div class="firstcolumnaleft">&lt;gBorderFrameWidth&gt;<br><small>from &lt;Colors&gt;</small></div></td>
<td class="hintcell">
We may configure DC so it will draw a rectangle around the active entry as we we cycle through them in a panel.<br>
This <code>&lt;gBorderFrameWidth&gt;</code> setting allows us to configure the width of the lines used to draw a rectangle around the current active entry.<br>
<code>&lt;gBorderFrameWidth&gt;</code> allows us to configure the width of the lines used to draw a rectangle around the current active entry.<br>
To view that rectangle, we should go in Configuration&nbsp;&gt; Options...&nbsp;&gt; Colors&nbsp;&gt; File panels and check the option <i>Use frame cursor</i>.<br>
<i>Example:</i> <code>&lt;gBorderFrameWidth&gt;1&lt;/gBorderFrameWidth&gt;</code>
</td>
Expand Down
25 changes: 17 additions & 8 deletions doc/en/copymove.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,10 @@ <h1>2.4. Copying/moving files</h1>
<h2>Content</h2>
<dl>
<dt>1. <a href="#confirmation">Copy/move dialog window</a></dt>
<dt>2. <a href="#progress">Operation progress dialog</a></dt>
<dt>3. <a href="#collisions">Name collisions</a></dt>
<dt>4. <a href="#aconfig">Additional settings</a></dt>
<dt>2. <a href="#clipboard">Using the clipboard</a></dt>
<dt>3. <a href="#progress">Operation progress dialog</a></dt>
<dt>4. <a href="#collisions">Name collisions</a></dt>
<dt>5. <a href="#aconfig">Additional settings</a></dt>
</dl>
</div>

Expand Down Expand Up @@ -56,8 +57,8 @@ <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. Not available in macOS<sup>(<a title="Note about macOS support" href="https://github.com/doublecmd/doublecmd/wiki/Supported-platforms#macos" target="_blank">*</a>)</sup>.</p></li>
<li><p><span class="italic">Check free space</span>&nbsp;&ndash; Double Commander calculates the size of the selected files, so it can check if there is enough free space in the target directory.</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 access to the file (for example, tmpfs), the program will report the verification failure. Keep in mind, this function significantly reduces the speed of the operation. Not available in macOS<sup>(<a title="Note about macOS support" href="https://github.com/doublecmd/doublecmd/wiki/Supported-platforms#macos" target="_blank">*</a>)</sup>.</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.</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>
<li><p><span class="italic">Correct links</span>&nbsp;&ndash; If enabled, Double Commander will check the links and, if necessary, correct their target path based on the target directory. If a relative path is specified, then the corrected path will also be written as relative.</p></li>
Expand All @@ -74,7 +75,15 @@ <h2><a name="confirmation">1. Copy/move dialog window</a></h2>
</div>

<div>
<h2><a name="progress">2. Operation progress dialog</a></h2>
<h2><a name="clipboard">2. Using the clipboard</a></h2>
<p>An additional way to copy or move files: we can use the <span class="italic">Copy</span> and <span class="italic">Paste</span> or <span class="italic">Cut</span> and <span class="italic">Paste</span> commands using the keyboard (<kbd>Ctrl+C</kbd>/<kbd>Ctrl+V</kbd> or <kbd>Ctrl+X</kbd>/<kbd>Ctrl+V</kbd> by default) or the corresponding items in the <a href="help.html#cm_ContextMenu">context menu</a>.</p>
<p>In this case, the operation will start without a confirmation dialog. Double Commander will use the operation settings saved as the default settings, except for the <span class="italic">Verify</span> parameter (see description above).</p>
<p>If a file is copied and pasted into the active panel (in the same directory), duplicate files will be created with automatic renaming using the template from the <a href="configuration.html#ConfigOperations">file operations settings</a>.</p>
<p class="navback"><a href="#topofpage">(back to top)</a></p>
</div>

<div>
<h2><a name="progress">3. Operation progress dialog</a></h2>
<p>This dialog box shows the details of the progress of the operation: two progress bars (for the currently processed file and the general), progress in percentage (in the title), the total number of files and the number of processed files, the full name of the current file and the name in the target directory, size, speed and remaining time.</p>
<p>Buttons:</p>
<ul>
Expand All @@ -87,7 +96,7 @@ <h2><a name="progress">2. Operation progress dialog</a></h2>
</div>

<div>
<h2><a name="collisions">3. Name collisions</a></h2>
<h2><a name="collisions">4. Name collisions</a></h2>
<p>If a file with the name of the file being copied already exists in the target directory, Double Commander will provide several actions. The choice of the action to be used automatically (without user involvement) will not be saved for subsequent calls of the copy/move operation.</p>
<p>If there is a folder with the same name:</p>
<ul>
Expand Down Expand Up @@ -121,7 +130,7 @@ <h2><a name="collisions">3. Name collisions</a></h2>
</div>

<div>
<h2><a name="aconfig">4. Additional settings</a></h2>
<h2><a name="aconfig">5. Additional settings</a></h2>
<p>Additional options related to copy/move operations are presented on the <a href="configuration.html#ConfigOperations">File operations</a> settings page.</p>
<p class="navback"><a href="#topofpage">(back to top)</a></p>
<br>
Expand Down
Loading