Skip to content

Commit c3c2ca2

Browse files
committed
Updated documentation for tool arguments.debugger.
1 parent 310acc7 commit c3c2ca2

1 file changed

Lines changed: 77 additions & 0 deletions

File tree

UserManual.md

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,9 @@ This manual includes a description of the system functionalities and capabilitie
4747
* [Fixed properties](#fixed-properties)
4848
* [Default properties](#default-properties)
4949
* [Environment variables](#environment-variables)
50+
* [Tools](#tools)
51+
* [file_explorer_renew](#file_explorer_renew)
52+
* [arguments.debugger](#argumentsdebugger)
5053
* [Plugins](#plugins)
5154
* [Plugin overview](#plugin-overview)
5255
* [C API](#c-api)
@@ -74,6 +77,7 @@ This manual includes a description of the system functionalities and capabilitie
7477
* [Keyboard mnemonics](#mnemonics--keyboard-shortcuts)
7578
* [Troubleshooting](#troubleshooting)
7679
* [Logging support](#logging-support)
80+
* [Checkout the _Tools_ section](#tools)
7781
* [Missing ampersand character (`&`) in menus](#missing-ampersand-character--in-menus)
7882
* [Reporting bugs](#reporting-bugs)
7983

@@ -1796,6 +1800,79 @@ The following table defines the list of pre-defined environment variables for Sh
17961800

17971801

17981802

1803+
# Tools #
1804+
1805+
1806+
## file_explorer_renew ##
1807+
1808+
**file_explorer_renew** is an utility provided with ShellAnything that can close and reopen all File Explorer windows.
1809+
1810+
Shell Extension DLLs cannot be easily deleted because _File Explorer_ usually have a lock on the file. File Explorer Renew is used to force File Explorer to release file locks on shell extentions such as ShellAnything.
1811+
1812+
The utility is useful during the [uninstall process](https://github.com/end2endzone/ShellAnything/blob/master/INSTALL.md#uninstall). For more details, see the [uninstall section of INSTALL.md](https://github.com/end2endzone/ShellAnything/blob/master/INSTALL.md#uninstall).
1813+
1814+
1815+
1816+
## arguments.debugger ##
1817+
1818+
**arguments debugger** is a set of two applications for debugging command line arguments sent to a program. When launched, they display individual arguments that started their process.
1819+
1820+
There are two applications `arguments.debugger.console.exe` and `arguments.debugger.window.exe`. The first is a console application, the second is a windows application. Both applications will show the individual command line arguments received from [<exec> action](#exec-action).
1821+
1822+
This tool allows one to properly escape string values to use as command line parameters.
1823+
1824+
For example, if you execute the following menu action:
1825+
```xml
1826+
<menu name="arguments.debugger">
1827+
<actions>
1828+
<exec
1829+
path="${application.directory}\arguments.debugger.window.exe"
1830+
arguments="This is &quot;multiple arguments at once&quot; including &quot;utf-8 characters&quot; such as the Greek alphabet Αα Ββ Γγ Δδ Εε Ζζ Ηη Θθ Ιι Κκ Λλ Μμ Νν Ξξ Οο Ππ Ρρ Σσ/ς Ττ Υυ Φφ Χχ Ψψ Ωω."
1831+
/>
1832+
</actions>
1833+
</menu>
1834+
```
1835+
arguments.debugger.window.exe will starts and show the following arguments:
1836+
```
1837+
argc=35
1838+
1839+
argv[0]=C:\Program Files\ShellAnything\bin\arguments.debugger.window.exe
1840+
argv[1]=This
1841+
argv[2]=is
1842+
argv[3]=multiple arguments at once
1843+
argv[4]=including
1844+
argv[5]=utf-8 characters
1845+
argv[6]=such
1846+
argv[7]=as
1847+
argv[8]=the
1848+
argv[9]=Greek
1849+
argv[10]=alphabet
1850+
argv[11]=Αα
1851+
argv[12]=Ββ
1852+
argv[13]=Γγ
1853+
argv[14]=Δδ
1854+
argv[15]=Εε
1855+
argv[16]=Ζζ
1856+
argv[17]=Ηη
1857+
argv[18]=Θθ
1858+
argv[19]=Ιι
1859+
argv[20]=Κκ
1860+
argv[21]=Λλ
1861+
argv[22]=Μμ
1862+
argv[23]=Νν
1863+
argv[24]=Ξξ
1864+
argv[25]=Οο
1865+
argv[26]=Ππ
1866+
argv[27]=Ρρ
1867+
argv[28]=Σσ/ς
1868+
argv[29]=Ττ
1869+
argv[30]=Υυ
1870+
argv[31]=Φφ
1871+
argv[32]=Χχ
1872+
argv[33]=Ψψ
1873+
argv[34]=Ωω.
1874+
```
1875+
17991876
# Plugins #
18001877

18011878

0 commit comments

Comments
 (0)