Skip to content

Commit

Permalink
fixes of docs linebreaks
Browse files Browse the repository at this point in the history
  • Loading branch information
steve02081504 committed Dec 31, 2024
1 parent c9a7967 commit 93d5b37
Show file tree
Hide file tree
Showing 7 changed files with 53 additions and 53 deletions.
2 changes: 1 addition & 1 deletion docs/README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ Help : 显示此帮助信息

### 错误处理

和大部分powershell函数不同,ps12exe设置`$LastExitCode`变量以表明错误,但不保证完全不抛出异常。
和大部分powershell函数不同,ps12exe设置`$LastExitCode`变量以表明错误,但不保证完全不抛出异常。
你可以使用类似以下的方式检查错误的发生:

```powershell
Expand Down
18 changes: 9 additions & 9 deletions docs/README_EN_UK.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Set-ps12exeContextMenu #Set the right-click menu

(You can also clone the repository and run `./ps12exe.ps1` directly.)

**Upgrading from PS2EXE to ps12exe? No problem!**
**Upgrading from PS2EXE to ps12exe? No problem!**
PS2EXE2ps12exe can hook the PS2EXE calls into ps12exe. Just uninstall PS2EXE and install this, then use PS2EXE as usual.

```powershell
Expand All @@ -45,7 +45,7 @@ Install-Module PS2EXE2ps12exe

### Right-Click Menu

Once you've run `Set-ps12exeContextMenu`, you can quickly compile any ps1 file into an exe, or open ps12exeGUI on the file, by right-clicking on it.
Once you've run `Set-ps12exeContextMenu`, you can quickly compile any ps1 file into an exe, or open ps12exeGUI on the file, by right-clicking on it.
![image](https://github.com/steve02081504/ps12exe/assets/31927825/24e7caf7-2bd8-46aa-8e1d-ee6da44c2dcc)

### GUI Mode
Expand Down Expand Up @@ -86,7 +86,7 @@ Starts a web server for compiling PowerShell scripts online.

### Error Handling

Unlike most proper PowerShell functions, ps12exe sets the `$LastExitCode` variable to show if it’s cocked up, but it doesn’t promise you won’t get a right old exception, yeah?
Unlike most proper PowerShell functions, ps12exe sets the `$LastExitCode` variable to show if it’s cocked up, but it doesn’t promise you won’t get a right old exception, yeah?
You can have a butcher's at whether it's gone wrong like this, see:

```powershell
Expand Down Expand Up @@ -200,8 +200,8 @@ $LocalizeData =
#_endif
```

Only the following conditions are supported: `PSEXE` and `PSScript`.
`PSEXE` is true, `PSScript` is false.
Only the following conditions are supported: `PSEXE` and `PSScript`.
`PSEXE` is true, `PSScript` is false.

#### `#_include <filename|url>`/`#_include_as_value <valuename> <file|url>`

Expand Down Expand Up @@ -298,7 +298,7 @@ When you need to require more than one module, you can use spaces, commas, or se

#### `#_pragma`

The pragma preprocessor directive has no effect on the content of the script, but it modifies the parameters used for compilation.
The pragma preprocessor directive has no effect on the content of the script, but it modifies the parameters used for compilation.
Here's an example:

```powershell
Expand Down Expand Up @@ -335,8 +335,8 @@ When the code reaches this point, the process exits with the given exit code and

### Minifyer

Since ps12exe's "compilation" embeds everything in the script verbatim as a resource in the resulting executable, the resulting executable will be large if the script has a lot of unnecessary strings.
You can specify a script block with the `-Minifyer` parameter that will process the script after preprocessing, before compilation, to achieve a smaller generated executable.
Since ps12exe's "compilation" embeds everything in the script verbatim as a resource in the resulting executable, the resulting executable will be large if the script has a lot of unnecessary strings.
You can specify a script block with the `-Minifyer` parameter that will process the script after preprocessing, before compilation, to achieve a smaller generated executable.

If you don't know how to write such a script block, you can use [psminnifyer](https://github.com/steve02081504/psminnifyer).

Expand All @@ -363,7 +363,7 @@ Compiled scripts process parameters like the original script does. One restricti
### Password Security

<a id="password-security-stuff"></a>
Never store passwords in your compiled script!
Never store passwords in your compiled script!
The entire script is easily visible to any .net decompiler.

![image](https://github.com/steve02081504/ps12exe/assets/31927825/92d96e53-ba52-406f-ae8b-538891f42779)
Expand Down
26 changes: 13 additions & 13 deletions docs/README_EN_US.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Set-ps12exeContextMenu # Set the right-click menu

(You can also clone this here repo and run `./ps12exe.ps1` directly.)

**Upgrading from PS2EXE to ps12exe? No problem!**
**Upgrading from PS2EXE to ps12exe? No problem!**
PS2EXE2ps12exe can hook the PS2EXE calls into ps12exe. Just uninstall PS2EXE, install this, and keep using PS2EXE like normal.

```powershell
Expand All @@ -45,7 +45,7 @@ Install-Module PS2EXE2ps12exe

### Right-Click Menu

Once you've run `Set-ps12exeContextMenu`, you can right-click any ps1 file to quickly compile it into an exe or open ps12exeGUI with that file.
Once you've run `Set-ps12exeContextMenu`, you can right-click any ps1 file to quickly compile it into an exe or open ps12exeGUI with that file.
![image](https://github.com/steve02081504/ps12exe/assets/31927825/24e7caf7-2bd8-46aa-8e1d-ee6da44c2dcc)

### GUI Mode
Expand Down Expand Up @@ -151,8 +151,8 @@ Help : Show this here help message.

### Error Handlin

Unlike most PowerShell functions, ps12exe sets the `$LastExitCode` variable to show if somethin' went sideways, but it ain't guaranteein' no exceptions.
You can check if somethin' messed up like this, see:
Unlike most PowerShell functions, ps12exe sets the `$LastExitCode` variable to show if somethin' went sideways, but it ain't guaranteein' no exceptions.
You can have a butcher's at whether it's gone wrong like this, see:

```powershell
$LastExitCodeBackup = $LastExitCode
Expand Down Expand Up @@ -200,8 +200,8 @@ $LocalizeData =
#_endif
```

Right now, only these conditions are supported: `PSEXE` and `PSScript`.
`PSEXE` is true; `PSScript` is false.
Right now, only these conditions are supported: `PSEXE` and `PSScript`.
`PSEXE` is true; `PSScript` is false.

#### `#_include <filename|url>`/`#_include_as_value <valuename> <file|url>`

Expand All @@ -212,7 +212,7 @@ Right now, only these conditions are supported: `PSEXE` and `PSScript`.

Includes the content of the file `<filename|url>` or `<file|url>` into the script. The file's content is inserted where the `#_include`/`#_include_as_value` command is.

Unlike the `#_if` statement, if you don't put quotes around the filename, the `#_include` commands treat trailing spaces and `#` as part of the filename.
Unlike the `#_if` statement, if you don't put quotes around the filename, the `#_include` commands treat trailing spaces and `#` as part of the filename as well.

```powershell
#_include $PSScriptRoot/super #weird filename.ps1
Expand All @@ -238,7 +238,7 @@ $result = & "$PSScriptRoot/another.ps1" -args
#_include_as_bytes <valuename> <file|url>
```

Includes a file's content as a base64 string or byte array during preprocessing. The file's content itself isn't preprocessed.
Includes a file's content as a base64 string or byte array at preprocessing time. The file content itself isn't preprocessed.

Here's a simple packer example:

Expand Down Expand Up @@ -312,7 +312,7 @@ Preprocessed script -> 23 bytes
Compiled file written -> 2560 bytes
```

As you can see, `#_pragma Console no` makes the generated exe run in windowed mode, even if we didn't specify `-noConsole` during compilation.
As you can see, `#_pragma Console no` makes the generated exe file run in windowed mode, even if we didn't specify `-noConsole` during compilation.
The pragma command can set any compilation parameter:

```powershell
Expand Down Expand Up @@ -378,19 +378,19 @@ if ($Host.Name -eq "PSEXE") { Write-Output "ps12exe" } else { Write-Output "Some

### Script Variables

Since ps12exe turns a script into an executable, `$MyInvocation` has different values than in a script.
Since ps12exe turns a script into an executable, the variable `$MyInvocation` is set to different values than in a script.

You can still use `$PSScriptRoot` to get the directory where the executable is, and the new `$PSEXEpath` to get the path of the executable itself.

### Window in Background in -noConsole Mode

When an external window is opened in a script with `-noConsole` (like for `Get-Credential` or a command that needs `cmd.exe`), the next window opens in the background.
When an external window is opened in a script with `-noConsole` mode (like for `Get-Credential` or a command that needs a `cmd.exe` shell), the next window opens in the background.

This happens because when the external window closes, Windows tries to activate the parent window. Since the compiled script has no window, the parent window of the compiled script gets activated instead, usually Explorer or PowerShell's window.

To fix this, `$Host.UI.RawUI.FlushInputBuffer()` opens an invisible window that can be activated. The next call of `$Host.UI.RawUI.FlushInputBuffer()` closes this window (and so on).
To fix this, `$Host.UI.RawUI.FlushInputBuffer()` opens an invisible window that can be activated. The following call of `$Host.UI.RawUI.FlushInputBuffer()` closes this window (and so on).

This example won't open a window in the background, unlike just calling `ipconfig | Out-String`:
The following example will not open a window in the background anymore, as a single call of `ipconfig | Out-String` will do:

```powershell
$Host.UI.RawUI.FlushInputBuffer()
Expand Down
4 changes: 2 additions & 2 deletions docs/README_ES.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ Help : Mostrar esta información de ayuda

### Manejo de Errores

A diferencia de la mayoría de las funciones de PowerShell, ps12exe establece la variable `$LastExitCode` para indicar errores, pero no garantiza que no se produzcan excepciones en absoluto.
A diferencia de la mayoría de las funciones de PowerShell, ps12exe establece la variable `$LastExitCode` para indicar errores, pero no garantiza que no se produzcan excepciones en absoluto.
Puedes comprobar si se ha producido un error utilizando algo similar a lo siguiente:

```powershell
Expand Down Expand Up @@ -215,7 +215,7 @@ Incluye el contenido del archivo `<nombre_archivo|url>` o `<archivo|url>` en el

A diferencia de la sentencia `#_if`, si no encierra el nombre del archivo entre comillas, la familia de comandos de preprocesamiento `#_include` trata el espacio final, `#`, como parte del nombre del archivo.

```powershell.
```powershell
#_include $PSScriptRoot/super #nombrearchivoextraño.ps1
#_include "$PSScriptRoot/filename.ps1" #¡comentario seguro!
```
Expand Down
30 changes: 15 additions & 15 deletions docs/README_FR.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

> [!CAUTION]
> Ne stockez jamais de mots de passe dans le code source !
> Consultez [ici](#sécurité-des-mots-de-passe) pour plus de détails.
> Consultez [ici](#sécurité-des-mots-de-passe) pour plus de détails.
## Introduction

ps12exe est un module PowerShell qui vous permet de créer des fichiers exécutables à partir de scripts .ps1.
ps12exe est un module PowerShell qui vous permet de créer des fichiers exécutables à partir de scripts .ps1.

[![CI](https://github.com/steve02081504/ps12exe/actions/workflows/CI.yml/badge.svg)](https://github.com/steve02081504/ps12exe/actions/workflows/CI.yml)
[![PSGallery download num](https://img.shields.io/powershellgallery/dt/ps12exe)](https://www.powershellgallery.com/packages/ps12exe)
Expand All @@ -33,7 +33,7 @@ Set-ps12exeContextMenu # Définir le menu contextuel du clic droit

(Vous pouvez également cloner ce référentiel et exécuter directement `.\ps12exe.ps1`)

**La migration de PS2EXE vers ps12exe est-elle difficile ? Pas de problème !**
**La migration de PS2EXE vers ps12exe est-elle difficile ? Pas de problème !**
PS2EXE2ps12exe peut relier les appels de PS2EXE à ps12exe. Il vous suffit de désinstaller PS2EXE et d’installer ceci, puis de l’utiliser comme vous le feriez avec PS2EXE.

```powershell
Expand All @@ -45,7 +45,7 @@ Install-Module PS2EXE2ps12exe

### Menu contextuel

Une fois que vous avez défini `Set-ps12exeContextMenu`, vous pouvez cliquer avec le bouton droit sur n'importe quel fichier ps1 pour le compiler rapidement en exe ou ouvrir ps12exeGUI pour ce fichier.
Une fois que vous avez défini `Set-ps12exeContextMenu`, vous pouvez cliquer avec le bouton droit sur n'importe quel fichier ps1 pour le compiler rapidement en exe ou ouvrir ps12exeGUI pour ce fichier.
![Image](https://github.com/steve02081504/ps12exe/assets/31927825/24e7caf7-2bd8-46aa-8e1d-ee6da44c2dcc)

### Mode GUI
Expand Down Expand Up @@ -151,7 +151,7 @@ Help : Affiche cette aide.

### Gestion des erreurs

Contrairement à la plupart des fonctions PowerShell, ps12exe définit la variable `$LastExitCode` pour indiquer les erreurs, mais ne garantit pas l'absence totale d'exceptions.
Contrairement à la plupart des fonctions PowerShell, ps12exe définit la variable `$LastExitCode` pour indiquer les erreurs, mais ne garantit pas l'absence totale d'exceptions.
Vous pouvez utiliser quelque chose comme ceci pour vérifier si des erreurs se sont produites :

```powershell
Expand All @@ -178,7 +178,7 @@ Les différentes valeurs de `$LastExitCode` représentent différents types d'er

### Prétraitement

ps12exe prétraite le script avant la compilation.
ps12exe prétraite le script avant la compilation.

```powershell
# Lit le cadre de programme à partir du fichier ps12exe.cs
Expand All @@ -200,8 +200,8 @@ $LocalizeData =
#_endif
```

Seules les conditions suivantes sont prises en charge pour le moment : `PSEXE` et `PSScript`.
`PSEXE` est vrai ; `PSScript` est faux.
Seules les conditions suivantes sont prises en charge pour le moment : `PSEXE` et `PSScript`.
`PSEXE` est vrai ; `PSScript` est faux.

#### `#_include <nom_de_fichier|url>`/`#_include_as_value <nom_de_valeur> <fichier|url>`

Expand All @@ -212,7 +212,7 @@ Seules les conditions suivantes sont prises en charge pour le moment : `PSEXE`

Inclut le contenu du fichier `<nom_de_fichier|url>` ou `<fichier|url>` dans le script. Le contenu du fichier est inséré à la position de la commande `#_include`/`#_include_as_value`.

Contrairement à l'instruction `#_if`, si vous n'entourez pas le nom de fichier avec des guillemets, les commandes de prétraitement `#_include` considèrent également les espaces de fin et `#` comme faisant partie du nom de fichier.
Contrairement à l'instruction `#_if`, si vous n'entourez pas le nom de fichier avec des guillemets, les commandes de prétraitement `#_include` considèrent également les espaces de fin et `#` comme faisant partie du nom de fichier.

```powershell
#_include $PSScriptRoot/super #nomdefichierbizarre.ps1
Expand Down Expand Up @@ -287,7 +287,7 @@ $modules | ForEach-Object{
}
```

Il convient de noter que le code généré ne fera qu'installer les modules, et non les importer.
Il convient de noter que le code généré ne fera qu'installer les modules, et non les importer.
Veuillez utiliser `Import-Module` en conséquence.

Lorsque vous devez requérir plusieurs modules, vous pouvez utiliser des espaces, des virgules ou des points-virgules, des virgules inversées comme séparateurs, et vous n'avez pas besoin d'écrire plusieurs instructions require.
Expand All @@ -298,7 +298,7 @@ Lorsque vous devez requérir plusieurs modules, vous pouvez utiliser des espaces

#### `#_pragma`

Les directives de prétraitement pragma n'ont aucun effet sur le contenu du script, mais modifient les paramètres utilisés pour la compilation.
Les directives de prétraitement pragma n'ont aucun effet sur le contenu du script, mais modifient les paramètres utilisés pour la compilation.
Voici un exemple :

```powershell
Expand All @@ -312,7 +312,7 @@ Script prétraité -> 23 octets
Fichier compilé écrit -> 2 560 octets
```

Comme vous pouvez le voir, `#_pragma Console no` fait fonctionner le fichier exe généré en mode fenêtre, même si nous n'avons pas spécifié `-noConsole` lors de la compilation.
Comme vous pouvez le voir, `#_pragma Console no` fait fonctionner le fichier exe généré en mode fenêtre, même si nous n'avons pas spécifié `-noConsole` lors de la compilation.
La commande pragma peut définir tous les paramètres de compilation :

```powershell
Expand All @@ -335,7 +335,7 @@ Lorsque le code est exécuté jusqu'à ce point, il quitte le processus avec le

### Minifier

Étant donné que la "compilation" de ps12exe incorpore tout le contenu du script en tant que ressource mot pour mot dans le fichier exécutable généré, si le script contient un grand nombre de chaînes de caractères inutiles, le fichier exécutable généré sera très volumineux.
Étant donné que la "compilation" de ps12exe incorpore tout le contenu du script en tant que ressource mot pour mot dans le fichier exécutable généré, si le script contient un grand nombre de chaînes de caractères inutiles, le fichier exécutable généré sera très volumineux.
Vous pouvez utiliser le paramètre `-Minifyer` pour spécifier un bloc de script qui prétraitera le script avant la compilation afin d'obtenir un fichier exécutable généré plus petit.

Si vous ne savez pas comment écrire un tel bloc de script, vous pouvez utiliser [psminnifyer](https://github.com/steve02081504/psminnifyer).
Expand Down Expand Up @@ -363,8 +363,8 @@ Les scripts compilés gèrent les paramètres comme le script d'origine. Une des
### Sécurité des mots de passe

<a id="password-security-stuff"></a>
Ne stockez jamais de mots de passe dans les scripts compilés !
L'ensemble du script est facilement visible pour n'importe quel décompilateur .net.
Ne stockez jamais de mots de passe dans les scripts compilés !
L'ensemble du script est facilement visible pour n'importe quel décompilateur .net.
![Image](https://github.com/steve02081504/ps12exe/assets/31927825/92d96e53-ba52-406f-ae8b-538891f42779)

### Différencier l'environnement par script
Expand Down
Loading

0 comments on commit 93d5b37

Please sign in to comment.