You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+16-14Lines changed: 16 additions & 14 deletions
Original file line number
Diff line number
Diff line change
@@ -59,25 +59,26 @@ Perl Executing Browser (PEB) is an HTML GUI for [Perl 5](https://www.perl.org/)
59
59
60
60
## Features
61
61
**Usability:**
62
-
*[Perl 5 scripts can be fed from HTML forms using direct GET and POST or AJAX requests to a built-in pseudo-domain](#feeding-from-forms).
63
-
*[Output from long running Perl 5 scripts can be seamlessly inserted into the HTML DOM of the calling local page](#data-only-scripts).
64
-
*[Linux superuser Perl scripts can be started](#calling-linux-superuser-perl-scripts).
65
-
*[Any version of Perl 5 can be used](#runtime-requirements).
66
-
*[PEB can be started from any folder](#settings).
62
+
63
+
*[Output from long running Perl 5 scripts can be seamlessly inserted into the HTML DOM of the calling local page.](#data-only-scripts)
64
+
*[Perl 5 scripts can be fed from HTML forms using direct GET and POST or AJAX requests to a built-in pseudo-domain.](#feeding-from-forms)
65
+
*[Linux superuser Perl scripts can be started.](#calling-linux-superuser-perl-scripts)
66
+
*[Any version of Perl 5 can be used.](#runtime-requirements)
67
+
*[PEB can be started from any folder.](#settings)
67
68
* PEB is useful for both single-page or multi-page applications.
68
-
*[Single file or multiple files, new filename, existing or new directory can be selected by user](#special-urls-for-users).
69
+
*[Single file or multiple files, new filename, existing or new directory can be selected by user.](#special-urls-for-users)
69
70
Their full paths can be displayed in the calling local page and they can be supplied to local Perl scripts.
70
-
*[Browser functions are accessible from special URLs](#browser-functions).
71
-
*[Any icon can be displayed on windows and message boxes](#icon).
72
-
*[Optional context menu translation using JavaScript ](#custom-or-translated-context-menu-labels).
73
-
*[Optional translation of the JavaScript *Alert*, *Confirm* and *Prompt* dialog boxes using JavaScript](#custom-or-translated-labels-for-javascript-dialog-boxes).
74
-
*[Optional warning for unsaved data in HTML forms before closing a window to prevent accidental data loss](#warning-for-unsaved-user-input-before-closing-a-window).
71
+
*[Browser functions are accessible from special URLs.](#browser-functions)
72
+
*[Any icon can be displayed on windows and message boxes.](#icon)
73
+
*[Optional context menu translation using JavaScript ](#custom-or-translated-context-menu-labels)
74
+
*[Optional translation of the JavaScript *Alert*, *Confirm* and *Prompt* dialog boxes using JavaScript](#custom-or-translated-labels-for-javascript-dialog-boxes)
75
+
*[Optional warning for unsaved data in HTML forms before closing a window to prevent accidental data loss](#warning-for-unsaved-user-input-before-closing-a-window)
75
76
* Cross-site scripting is disabled for all web and local pages.
76
77
77
78
**Development goodies:**
78
-
* PEB can interact with the Perl 5 debugger in graphical mode - see section [HTML Interface for the Perl Debugger](#html-interface-for-the-perl-debugger)
79
+
*[PEB can interact with the Perl 5 debugger in graphical mode.](#html-interface-for-the-perl-debugger)
79
80
*```QWebInspector``` window can be invoked using ```Ctrl+I``` keyboard shortcut.
80
-
*Extensive optional logging of all browser actions.
81
+
*[Optional extensive logging of all browser actions.](#log-files)
81
82
82
83
## Compile-time Requirements
83
84
GCC compiler and Qt 5.1 - Qt 5.5 headers.
@@ -183,7 +184,8 @@ PEB is designed to run from any directory without setting anything beforehand an
183
184
A PEB-based application can have its own icon and it must be located at ```{PEB_binary_directory}/resources/app/app.png```. If this file is found during application startup, it will be used as the icon of all windows and dialog boxes. If this file is not found, the default icon embedded into the resources of the browser binary will be used.
184
185
***Trusted domains:**
185
186
If PEB is able to read ```{PEB_binary_directory}/resources/app/trusted-domains.json```, all domains listed in this file are considered trusted. Only the local pseudo-domain ```http://local-pseudodomain/``` is trusted if ```trusted-domains.json``` is missing. This setting should be used with care - see section [Security](#security).
186
-
***Log files:**
187
+
***Log files:**
188
+
<aname="log-files"></a>
187
189
If log files are needed for debugging of PEB or a PEB-based application, they can easily be turned on by manually creating ```{PEB_binary_directory}/logs```. If this directory is found during application startup, the browser assumes that logging is required and a separate log file is created for every browser session following the naming convention: ```{application_name}-started-at-{four_digit_year}-{month}-{day}--{hour}-{minute}-{second}.log```. PEB will not create ```{PEB_binary_directory}/logs``` on its own and if this directory is missing, no logs will be written, which is the default behavior. Please note, that every requested link is logged and log files can grow rapidly. If disc space is an issue, writing log files can be turned off by simply removing or renaming ```{PEB_binary_directory}/logs```.
0 commit comments