Skip to content

Commit 6f7badf

Browse files
committed
There Can Be Only One
The `-z` and `-pluginMessage` command-line options both follow Highlander rules: "There Can Be Only One". The UM needs to make this abundantly clear to users.
1 parent 795bb91 commit 6f7badf

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

content/docs/command-prompt.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -172,6 +172,7 @@ code | file
172172
* `-openFoldersAsWorkspace`: Any folders listed as arguments will be opened as a workspace, rather than opening all the contained files individually.
173173
* `-titleAdd="additional title bar text"`: Add a dash and a space and the supplied text to the right side of the application title bar (new to v8.0.0).
174174
* `-pluginMessage="text for plugin(s)"`: If plugin developers need extra command line arguments, then users can add this option, and the plugin will be [notified](../plugin-communication/#NPPN_CMDLINEPLUGINMSG "NPPN_CMDLINEPLUGINMSG") that it can parse that string for extra information (new to v8.4.2).
175+
- You can only give Notepad++ _one_ `-pluginMessage` argument. If you have multiple pieces of information you want to pass to one or more plugins, they have to be joined together, such as, `-pluginMessage="arg1=Val1;arg2=Val2"`, and the plugin has to know how to split the contents of that message into the pieces that the plugin needs.
175176
* `filepath`: File or folder name to open (absolute or relative path name).
176177

177178
The order of the options is not important. Brackets indicate that the options
@@ -197,8 +198,9 @@ usage list. These are intended for advanced usage or other special circumstance
197198
a command-line option when you try to print the file from the Explorer Context menu.
198199
Enabling this option allows Notepad++ to recognize that option, and convert it internally
199200
to the official `-quickPrint` option.
200-
* `-z`: Causes Notepad++ to ignore the next command line argument (a single word, or a phrase in quotes). The only intended and
201-
supported use for this option is for the [Notepad Replacement](../other-resources/#notepad-replacement) syntax.
201+
* `-z`: Causes Notepad++ to ignore the next command line argument (a single word, or a phrase in quotes).
202+
- The only intended and supported use for this option is for the [Notepad Replacement](../other-resources/#notepad-replacement) syntax. Any other use for this option is unsupported and not guaranteed to work.
203+
- There can only be one `-z` per command-line, because that is all that is required for [Notepad Replacement](../other-resources/#notepad-replacement).
202204

203205
## Installer Options
204206

0 commit comments

Comments
 (0)