Skip to content

Commit c8afea4

Browse files
committed
Documentation update.
1 parent 18d744e commit c8afea4

16 files changed

+253
-20
lines changed

Changelog.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,9 @@ Versioning guidelines for SemVer can be found at: http://www.semver.org/
1212
slightly reduce complaints sometimes made by certain code quality checkers
1313
and such). It's also less messy now to use an integer value of zero as a key.
1414

15-
- [2018.12.23; Documentation; Maikuolan]: Completed translating the SigTool
16-
README to German. This totals 11 translations now available.
15+
- [2018.12.23-25; Documentation; Maikuolan]: Completed translating the SigTool
16+
README to German, Russian, Korean, and Japanese. This totals 14 translations
17+
now available.
1718

1819
=== Version/Release 0.2.2 ===
1920
PATCH RELEASE.

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[![Join the chat at https://gitter.im/phpMussel2/Lobby](https://badges.gitter.im/phpMussel2/Lobby.svg)](https://gitter.im/phpMussel2/Lobby)
2-
[![PHP >= 7.0.3](https://img.shields.io/badge/PHP-%3E%3D%207.0.0-8892bf.svg)](https://maikuolan.github.io/Compatibility-Charts/)
2+
[![PHP >= 7.0.3](https://img.shields.io/badge/PHP-%3E%3D%207.0.3-8892bf.svg)](https://maikuolan.github.io/Compatibility-Charts/)
33
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
44
[![PRs Welcome](https://img.shields.io/badge/PRs-Welcome-brightgreen.svg)](http://makeapullrequest.com)
55

@@ -45,6 +45,8 @@ More information can be found in the documentation herein.
4545
- **[Français](https://github.com/phpMussel/SigTool/blob/master/_docs/readme.fr.md)**
4646
- **[Bahasa Indonesia](https://github.com/phpMussel/SigTool/blob/master/_docs/readme.id.md)**
4747
- **[Italiano](https://github.com/phpMussel/SigTool/blob/master/_docs/readme.it.md)**
48+
- **[日本語](https://github.com/phpMussel/SigTool/blob/master/_docs/readme.ja.md)**
49+
- **[한국어](https://github.com/phpMussel/SigTool/blob/master/_docs/readme.ko.md)**
4850
- **[Nederlandse](https://github.com/phpMussel/SigTool/blob/master/_docs/readme.nl.md)**
4951
- **[Português](https://github.com/phpMussel/SigTool/blob/master/_docs/readme.pt.md)**
5052
- **[Русский](https://github.com/phpMussel/SigTool/blob/master/_docs/readme.ru.md)**
@@ -55,4 +57,4 @@ More information can be found in the documentation herein.
5557
---
5658

5759

58-
Last Updated: 23 December 2018 (2018.12.23).
60+
Last Updated: 24 December 2018 (2018.12.24).

_docs/readme.de.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ Vor der Installation, bitte überprüfen Sie, was erforderlich ist. Wenn was erf
55
#### Erforderlich:
66
- PHP >= `7.0.3` mit zlib + phar unterstützung.
77
- >= 1GB freier Festplattenspeicher (wenn direkt von der Festplatte arbeiten) oder verfügbarer RAM (wenn Sie ein RAM-Laufwerk verwenden; empfohlen).
8-
- Möglichkeit für PHP im CLI-Modus zu betreiben (commandEingabeaufforderung, Terminal, Shell, u.s.w.).
8+
- Möglichkeit für PHP im CLI-Modus zu betreiben (Eingabeaufforderung, Terminal, Shell, u.s.w.).
99

1010
SigTool existiert als eigenständige PHP-Datei und hat keine externen Abhängigkeiten (abgesehen von den oben aufgeführten), und so, um es zu "installieren", müssen Sie `sigtool.php` herunterladen (nichts anderes wird benötigt).
1111

12-
SigTool kann auf normale Weise von einem Datenträger oder Speichermedium auf die gleiche Weise wie jedes andere PHP-Skript arbeiten. Aufgrund jedoch die großen Anzahl der ausgeführten Lese/Schreibvorgänge, es wird dringend empfohlen, es von einem RAM-Laufwerk aus zu betreiben, weil dies seine Geschwindigkeit etwas erhöhen und überschüssige Lese/Schreibvorgänge reduzieren. Die endgültige Ausgabe sollte ungefähr ~64MB nicht überschreiten, aber im normalen Betrieb sind ungefähr ~1GB freier Festplattenspeicher oder verfügbarer RAM erforderlich aufgrund temporärer Arbeitsdateien und um Lese/Schreibfehler zu vermeiden.
12+
SigTool kann auf normale Weise von einem Datenträger oder Speichermedium auf die gleiche Weise wie jedes andere PHP-Skript arbeiten. Aufgrund jedoch der großen Anzahl der ausgeführten Lese/Schreibvorgänge, es wird dringend empfohlen, es von einem RAM-Laufwerk aus zu betreiben, weil dies seine Geschwindigkeit etwas erhöhen und überschüssige Lese/Schreibvorgänge reduzieren. Die endgültige Ausgabe sollte ungefähr ~64MB nicht überschreiten, aber im normalen Betrieb sind ungefähr ~1GB freier Festplattenspeicher oder verfügbarer RAM erforderlich aufgrund temporärer Arbeitsdateien und um Lese/Schreibfehler zu vermeiden.
1313

1414
---
1515

@@ -36,6 +36,8 @@ Die Ausgabe ist verschiedenen phpMussel-Signaturdateien, direkt aus der ClamAV-S
3636

3737
Die Ausgabe wird direkt in demselben Verzeichnis wie `sigtool.php` erzeugt. Quelldateien und alle temporären Arbeitsdateien werden im laufenden Betrieb gelöscht (so, wenn Sie Kopien von `daily.cvd` und `main.cvd` behalten möchten, Sie sollten Kopien erstellen, bevor Sie die Signaturdateien verarbeiten).
3838

39+
Wenn Sie mit SigTool neue Signaturdateien erstellen, kann es sein dass der Antiviren-Scanner Ihres Computers versucht, die neu erstellten Signaturdateien zu löschen oder in die Quarantäne zu stellen. Dies ist darauf zurückzuführen, dass die Signaturdateien manchmal Daten enthalten, die den Daten sehr ähnlich sind, nach denen Ihr Antivirus beim Scannen sucht. Die von SigTool erzeugten Signaturdateien enthalten jedoch keinen ausführbaren Code und sind völlig harmlos. Wenn dieses Problem auftritt, können Sie versuchen, Ihren Antiviren-Scanner vorübergehend zu deaktivieren, oder Ihren Antiviren-Scanner so konfigurieren, dass das Verzeichnis, in dem Sie neue Signaturdateien erstellen, in die Whitelist aufgenommen wird.
40+
3941
Wenn sich die `signatures.dat` YAML-Datei bei der Verarbeitung in demselben Verzeichnis befindet, Versionsinformationen und Prüfsummen werden entsprechend aktualisiert (so, wenn Sie SigTool verwenden um das `phpMussel/Signatures`-Repository zu aktualisieren, dies sollte enthalten sein).
4042

4143
*Beachten: Wenn Sie phpMussel-Benutzer sind, bitte bedenke, dass Signaturdateien AKTIV sein müssen, damit sie korrekt funktionieren! Wenn Sie SigTool verwenden um neue Signaturdateien zu erstellen, Sie können sie "aktivieren", indem Sie sie in der "Active"-Direktive der phpMussel-Konfiguration auflisten. Wenn Sie die Front-End-Aktualisierungsseite verwenden, um Signaturdateien zu installieren und zu aktualisieren, Sie können sie direkt von der Front-End-Aktualisierungsseite aus aktivieren. Beide Methoden verwenden sind jedoch nicht erforderlich. Auch, für optimale Leistung, es wird empfohlen nur verwenden Sie die Signaturdateien, die Sie für Ihre Installation benötigen (z.B., wenn ein bestimmter Dateityp auf der schwarzen Liste steht, Sie werden wahrscheinlich keine Signaturdateien benötigen, die diesem Dateityp entsprechen; das Analysieren von Dateien, die trotzdem blockiert werden, ist überflüssige Arbeit und kann den Scanvorgang erheblich verlangsamen).*
@@ -96,4 +98,4 @@ clamav_swf_regex.db | Es handelt sich um SWF-Dateien; Funktioniert mit Rohdaten;
9698
---
9799

98100

99-
Zuletzt aktualisiert: 23 Dezember 2018 (2018.12.23).
101+
Zuletzt aktualisiert: 26 Dezember 2018 (2018.12.26).

_docs/readme.en.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@ Output produced is various phpMussel signature files generated directly from the
3636

3737
Output is produced directly into the same directory as `sigtool.php`. Source files and all temporary working files will be deleted during the course of operation (so, if you want to keep copies of `daily.cvd` and `main.cvd`, you should make copies before processing the signature files).
3838

39+
When using SigTool to generate new signature files, it's possible that your computer's anti-virus scanner may attempt to delete or quarantine the newly generated signature files. This happens because sometimes, the signature files may contain data very similar to the data that your anti-virus looks for when scanning. However, the signature files generated by SigTool don't contain any executable code, and are completely benign. If you encounter this problem, you can try to temporarily disable your anti-virus scanner, or configure your anti-virus scanner to whitelist the directory where you're generating new signature files.
40+
3941
If the `signatures.dat` YAML file is included in the same directory when processing, version information and checksums will be updated accordingly (so, when using SigTool to update the `phpMussel/Signatures` repository, this should be included).
4042

4143
*Note: If you're a phpMussel user, please remember that signature files must be ACTIVE in order for them to work correctly! If you're using SigTool to generate new signature files, you can "activate" them by listing them in the phpMussel configuration "Active" directive. If you're using the front-end updates page to install and update signature files, you can "activate" them directly from the front-end updates page. However, using both methods is not necessary. Also, for optimum phpMussel performance, it's recommended that you only use the signature files that you need for your installation (e.g., if some particular type of file is blacklisted, you probably won't need signature files corresponding to that type of file; analysing files that will be blocked anyway is superfluous work and can significantly slow the scan process).*
@@ -96,4 +98,4 @@ clamav_swf_regex.db | Targets SWF files; Works with raw data; Signatures can con
9698
---
9799

98100

99-
*Last modified: 9 September 2017 (2017.09.09).*
101+
Last Updated: 26 December 2018 (2018.12.26).

_docs/readme.es.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ SigTool puede funcionar normalmente desde un disco o medio de almacenamiento de
1313

1414
---
1515

16+
1617
### Cómo utilizar:
1718

1819
Tenga en cuenta que SigTool NO es una aplicación web basada en PHP (o web-app)! SigTool es una aplicación CLI basada en PHP (o CLI-app) destinado a ser utilizado con terminal, shell, etc. Se puede invocar llamando al binario PHP con el archivo `sigtool.php` como su primer argumento:
@@ -35,6 +36,8 @@ La salida producida es varios archivos de firmas para phpMussel generados direct
3536

3637
La salida se produce directamente en el mismo directorio que `sigtool.php`. Los archivos fuente y todos los archivos de trabajo temporales se borrarán durante el curso de la operación (por lo tanto, si desea guardar copias de `daily.cvd` y `main.cvd`, debe hacer copias antes de procesar los archivos de firmas).
3738

39+
Cuando lo usar SigTool para generar nuevos archivos de firmas, es posible que el analizador antivirus de su computadora intentará eliminar o poner en cuarentena los archivos de firmas generados. Esto puede ocurrir porque, a veces, los archivos de firmas pueden contener datos muy similares a los datos que su antivirus busca al escanear. Sin embargo, los archivos de firmas generados por SigTool no contienen ningún código ejecutable y son completamente benignos. Si encuentra este problema, puede intentar desactivar temporalmente su analizador antivirus, o configurar su antivirus para incluir en la lista blanca el directorio donde está generando los archivos de firmas nuevos.
40+
3841
Si el archivo de YAML `signatures.dat` se incluye en el mismo directorio al procesar, la información de la versión y las sumas de comprobación se actualizarán en consecuencia (por lo tanto, al usar SigTool para actualizar el repositorio `phpMussel/Signatures`, esto debe ser incluido).
3942

4043
*Nota: Si eres un usuario de phpMussel, por favor recuerda que los archivos de firma deben estar ACTIVOS para que funcionen correctamente. Si utiliza SigTool para generar nuevos archivos de firmas, puedes "activarlos" enumerándolos en la directiva de configuración "Active" de phpMussel. Si está utilizando la página de actualizaciones del front-end para instalar y actualizar archivos de firmas, usted puede "activar" ellos directamente de allí. Aunque, no es necesario usar ambos métodos. Además, para un rendimiento óptimo de phpMussel, se recomienda que sólo utilice los archivos de firmas que necesita para su instalación (p.ej., si algún tipo particular de archivo está en la lista negra, probablemente no necesitará archivos de firmas correspondientes a ese tipo de archivo; analizar los archivos que se bloquearán de todos modos es un trabajo superfluo y puede ralentizar significativamente el proceso de escaneo).*
@@ -43,6 +46,7 @@ Una demostración de vídeo para usar SigTool está disponible en YouTube: __[yo
4346

4447
---
4548

49+
4650
### Lista de archivos de firmas generados por SigTool:
4751
Archivo de firmas | Descripción
4852
---|---
@@ -75,6 +79,7 @@ clamav_swf_regex.db | Destinado a archivos SWF; Funciona con datos sin procesar;
7579

7680
---
7781

82+
7883
### Nota relativa a las extensiones de archivos de firmas:
7984
*Esta información se ampliará en el futuro.*
8085

@@ -92,4 +97,5 @@ clamav_swf_regex.db | Destinado a archivos SWF; Funciona con datos sin procesar;
9297

9398
---
9499

95-
*Última modificación: 4 Septiembre 2017 (2017.09.04).*
100+
101+
Última Actualización: 26 Diciembre de 2018 (2018.12.26).

_docs/readme.fr.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Avant l'installation, vérifiez les conditions requises. Si ceux-ci ne sont pas
44

55
#### Les conditions requises :
66
- PHP >= `7.0.3` avec support de zlib + Phar.
7-
- >= 1Go d'espace disque libre (si vous travaillez directement à partir du disque) ou RAM disponible (si vous utilisez un disque RAM; recommandé).
7+
- >= 1Go d'espace disque libre (si vous travaillez directement à partir du disque) ou RAM disponible (si vous utilisez un disque RAM ; recommandé).
88
- Capacité d'opérer PHP en mode CLI (invite de commande, le terminal, shell, etc).
99

1010
SigTool existe en tant que fichier PHP autonome et n'a pas de dépendances externes (autres que les conditions énumérées ci-dessus), et donc, la seule chose que vous devez faire pour « l'installer », c'est télécharger `sigtool.php`.
@@ -28,14 +28,16 @@ Drapeaux possibles :
2828
- `p` : Procurez-vous des fichiers de signature à utiliser avec phpMussel.
2929
- `m` : Télécharger `main.cvd` avant le traitement.
3030
- `d` : Télécharger `daily.cvd` avant le traitement.
31-
- `u` : Mettre à jour SigTool (télécharge `sigtool.php` à nouveau et die; aucun contrôle effectué).
31+
- `u` : Mettre à jour SigTool (télécharge `sigtool.php` à nouveau et die ; aucun contrôle effectué).
3232

3333
La sortie produite est divers fichiers de signature pour phpMussel, généré directement à partir de la base de données de signature pour ClamAV, sous deux formes :
3434
- Fichiers de signatures qui peuvent être insérés directement dans le répertoire `/vault/signatures/`.
3535
- Copies des fichiers de signatures compressés avec GZ qui peuvent être utilisés pour mettre à jour le référentiel `phpMussel/Signatures`.
3636

3737
La sortie est produite directement dans le même répertoire que `sigtool.php`. Les fichiers source et tous les fichiers de travail temporaire seront supprimés au cours de l'opération (donc, si vous souhaitez conserver des copies des fichiers `daily.cvd` et `main.cvd`, vous devriez faire des copies avant de les traiter).
3838

39+
Quand vous utilisez SigTool pour générer de nouveaux fichiers de signatures, il est possible que l'analyseur antivirus de votre ordinateur tente de supprimer ou de mettre en quarantaine les fichiers de signatures nouvellement générés. Cela est dû au fait que les fichiers de signatures peuvent parfois contenir des données très similaires à celles que votre anti-virus recherche lors de l'analyse. Cependant, les fichiers de signatures générés par SigTool ne contiennent aucun code exécutable, et sont totalement inoffensifs. Si vous rencontrez ce problème, vous pouvez essayer de désactiver temporairement votre analyseur antivirus, ou configurer de manière à ce que le répertoire dans lequel vous générez de nouveaux fichiers de signatures soit ajouté à la liste blanche.
40+
3941
Si le fichier YAML `signatures.dat` est inclus dans le même répertoire lors du traitement, les informations de version et les sommes de contrôle seront mises à jour en conséquence (donc, lorsque vous utilisez SigTool pour mettre à jour le référentiel `phpMussel/Signatures`, cela devrait être inclus).
4042

4143
*Note : Si vous êtes un utilisateur phpMussel, n'oubliez pas que les fichiers de signatures doivent être ACTIF pour qu'ils fonctionnent correctement ! Si vous utilisez SigTool pour générer de nouveaux fichiers de signatures, vous pouvez les « activer » en les répertoriant dans la directive de configuration de phpMussel, « Active ». Si vous utilisez la page des mises à jour avant pour installer et mettre à jour les fichiers de signatures, vous pouvez les « activer » directement à partir de la page de mise à jour de l'accès frontal. Cependant, l'utilisation des deux méthodes n'est pas nécessaire. Aussi, pour une performance de phpMussel optimale, il est recommandé d'utiliser uniquement les fichiers de signature dont vous avez besoin pour votre installation (par exemple, si un type particulier de fichier est en liste noire, vous n'aurez probablement pas besoin de fichiers de signatures correspondant à ce type de fichier ; l'analyse des fichiers qui seront bloqués de toute façon est un travail superflu et peut considérablement ralentir le processus d'analyse).*
@@ -96,4 +98,4 @@ clamav_swf_regex.db | Cible les fichiers SWF ; Fonctionne avec des données bru
9698
---
9799

98100

99-
*Dernière modification : 4 Septembre 2017 (2017.09.04).*
101+
Dernière mise à jour : 26 Décembre 2018 (2018.12.26).

_docs/readme.id.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@ Output yang dihasilkan adalah berbagai file tanda tangan phpMussel yang dihasilk
3636

3737
Output diproduksi langsung ke direktori yang sama dengan `sigtool.php`. File sumber dan semua file kerja sementara akan dihapus selama operasi berlangsung (jadi, jika Anda ingin menyimpan salinan `daily.cvd` dan `main.cvd`, Anda harus membuat salinan sebelum memproses file tanda tangan).
3838

39+
Saat menggunakan SigTool untuk membuat file tanda tangan baru, mungkin pemindai anti-virus komputer Anda dapat mencoba untuk menghapus atau mengkarantina file tanda tangan yang baru dibuat. Ini terjadi karena kadang-kadang, file tanda tangan mungkin berisi data yang sangat mirip dengan data yang dicari oleh anti-virus Anda saat memindai. Namun, file tanda tangan yang dibuatkan oleh SigTool tidak mengandung kode yang dapat dieksekusi, dan sepenuhnya jinak. Jika Anda mengalami masalah ini, Anda dapat mencoba untuk menonaktifkan sementara pemindai anti-virus Anda, atau mengkonfigurasi pemindai anti-virus Anda untuk dimasukkan ke dalam daftar putih direktori tempat Anda membuat file tanda tangan baru.
40+
3941
Jika file YAML `signatures.dat` disertakan dalam direktori yang sama saat memproses, informasi versi dan checksum akan diperbarui sesuai dengan itu (jadi, saat menggunakan SigTool untuk memperbarui repositori `phpMussel/Signatures`, ini harus disertakan).
4042

4143
*Catatan: Jika Anda pengguna phpMussel, harap diingat bahwa file tanda tangan harus AKTIF agar mereka dapat bekerja dengan benar! Jika Anda menggunakan SigTool untuk menghasilkan file tanda tangan baru, Anda dapat "mengaktifkan" mereka dengan mencantumkannya di direktif konfigurasi "Active" dalam phpMussel. Jika Anda menggunakan halaman pembaruan bagian depan untuk menginstal dan memperbarui file tanda tangan, Anda bisa "mengaktifkan" mereka langsung dari halaman pembaruan bagian depan. Namun, menggunakan kedua metode tersebut tidaklah perlu. Juga, untuk kinerja optimal phpMussel, sebaiknya Anda hanya menggunakan file tanda tangan yang Anda butuhkan untuk instalasi Anda (misalnya, jika beberapa jenis file tertentu dimasukkan dalam daftar hitam, Anda mungkin tidak memerlukan file tanda tangan yang sesuai dengan jenis file tersebut; menganalisis file yang akan diblokir tetap adalah pekerjaan yang berlebihan dan secara signifikan dapat memperlambat proses pemindaian).*
@@ -96,4 +98,4 @@ clamav_swf_regex.db | Menargetkan file SWF; Bekerja dengan data mentah; Tanda ta
9698
---
9799

98100

99-
*Modifikasi terakhir: 4 September 2017 (2017.09.04).*
101+
Terakhir Diperbarui: 26 Desember 2018 (2018.12.26).

0 commit comments

Comments
 (0)