Skip to content

de_userdocumentation

viper3400 edited this page Sep 5, 2015 · 1 revision

RegExTractor Benutzerdokumentation

Einleitung

RegExTractor durchsucht Dateien in einem Verzeichnis nach Vorkommen ein oder mehrerer regulärer Ausdrücke. Das Suchergebnis wird strukturiert in einer XML Datei ausgegeben.

Die regulären Ausdrücke müssen in einer separaten Textdatei erfasst werden. Dabei wird ein regulärer Ausdruck pro Zeile erwartet.

Das generisch generierte XML kann durch geeignete XSL Stylesheets mit geeigneten XSLT Prozessoren (nicht enthalten) in ein gewünschtes Format transformiert werden.

Parameter

Dem Benutzer von RegExTractor müssen die folgenden Parameter bekannt sein:

Zu durchsuchendes Verzeichnis

  • Die Dateien in diesem Verzeichnis werden nach dem Vorkommen der Suchbegriffe durchsucht.

Rekursiver Modus

  • Gibt an, ob auch Dateien in Unterverzeichnissen des zuvor genannten Hauptverzeichnisses durchsucht werden sollen.

Filter

  • Gibt an, ob auf die Dateinamen ein Filter angewendet werden soll.
  • "*" oder "*.*" durchsucht alle Dateien (Standard)
  • "*.txt" durchsucht nur Textdateien
  • "error*.*" durchsucht nur Dateien, in deren Namen mit "error" beginnt.

SearchTermFile

  • Gibt den Namen der Textdatei an, die die Suchausdrücke enthält, nach denen das zuvor genannten Verzeichnis unter Berücksichtigung des genannten Filters durchsucht werden soll.
  • Die Textdatei kann einen oder mehrere reguläre Ausdrücke enthalten, dabei muss jeder reguläre Ausdruck auf einer neuen Zeile stehen.

Ausgabedatei

  • Bezeichnet den Namen und den Pfad der XML Datei, in die die Suchresultate geschrieben werden

Benutzung

Verwendung der grafischen Oberfläche

Nach dem Entpacken des ZIP Archivs findet sich unter .\RegExTractorWin die RegExTractor.exe. In der grafischen Oberfläche können die oben genannten Parameter befüllt werden und die Suche gestartet werden.

Verwendung der Kommandozeilenversion

Nach dem Entpacken des ZIP Archivs findet sich unter .\RegExTractorConsole die RegExTractorConsole.exe, welche aus einem Kommandofenster gestarte werden kann. Das Tool muss mit den notwendigen Parametern gestartet werden.

-d, --directory Required. Directory to which the search will be applied.

-r, --recursive Required. Definies if the search runs in recursive mode.

-f, --filter (Default: *) Filter for files to search in.

-s, --searchtermfile Required. Set the input file which holds the search terms.

-o, --outputfile Required. Sets the xml output file.

--help Display this help screen.

Bsp:> RegExTractorConsole.exe -d C:\temp\logs -f *.log -s C:\temp\searchterm.txt -o c:\temp\output.xml

Verwendung in Notepad++ (Plugin)

Unter https://github.com/viper3400/NppRegExTractor steht ein Plugin für Notepad++ zur Verfügung. Dieses entspricht im Wesentlichen der grafischen Oberfläche der Windows Form Anwendung, integriert sich jedoch in Notepad++.

Grafische Darstellung der Funktionsweise