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: UserManual.md
+13-16Lines changed: 13 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -831,15 +831,17 @@ ShellAnything provides logging support for troubleshooting and debugging command
831
831
832
832
### Location ###
833
833
834
-
The log files are stored in the user's home directory available in `C:\Users\%USERNAME%\ShellAnything\Logs` directory where `%USERNAME%` matches your current login username.
835
-
For instance, the user `JohnSmith` can find his ShellAnything log files in directory `C:\Users\JohnSmith\ShellAnything\Logs`.
834
+
The logging directory is unique for each users of the system.
835
+
836
+
The log files are stored in `C:\Users\%USERNAME%\ShellAnything\Logs` directory where `%USERNAME%` matches your current login username.
837
+
For example, the user `JohnSmith` can find his own ShellAnything log files in directory `C:\Users\JohnSmith\ShellAnything\Logs`.
836
838
837
839
838
840
839
841
### Filename Format ###
840
842
841
843
The log files names are generated in the following format:
842
-
`<name>.<LEVEL>.<date>-<time>.<pid>.log`.
844
+
`name.LEVEL.date-time.pid.log`.
843
845
844
846
The following table defines each field identifier in the filename format:
845
847
@@ -851,8 +853,7 @@ The following table defines each field identifier in the filename format:
851
853
| time | The current date when the file was created in `hhmmss` format. |
852
854
| pid | The Process Id which generates the log message. |
853
855
854
-
For example, the following filename is a valid log file format:
855
-
`shellext.dll.INFO.20191125-083305.9456.log`
856
+
For example, `shellext.dll.INFO.20191125-083305.9456.log` is a valid log filename.
See [Filename Format](#filename-format) for details.
874
875
875
-
Each log file contains the messages at it's matching level but also the messages with a higher severity.
876
+
Each log file contains the messages of it's matching level but also the messages with higher severity.
876
877
In other words, all logs messages are available in the INFO log file, including messages logged with WARNING and ERROR levels.
877
878
878
-
The ERROR log file contains all messages with ERROR level.
879
-
The WARNING log file contains all messages with ERROR and WARNING levels.
879
+
The ERROR log file contains all messages with ERROR level.</br>
880
+
The WARNING log file contains all messages with ERROR and WARNING levels.</br>
880
881
The INFO log file contains all messages with ERROR, WARNING and INFO levels.
881
882
882
883
Debugging log messages are only available in debug builds of the application.
883
884
884
885
885
886
886
-
### Log files life cycle###
887
+
### Log files life cycle###
887
888
888
-
The log files are kept for a maximum of 5 days.
889
+
The log files are kept for a maximum of 5 days. This is for security reason as the files may contains sensitive information.
889
890
890
891
On application startup, the existing log files are all validated and files older than 5 days are deleted.
891
892
892
-
To force the the application restart, one can do one of the following:
893
-
* reboot the computer, open a new Windows Explorer.
894
-
* close all Windows Explorer before opening a new Window Explorer window.
895
-
896
-
This is for security reason as the files may contains sensitive information.
893
+
To force the application restart, reboot the computer and open a new Windows Explorer or close all Windows Explorer before opening a new Window Explorer window.
897
894
898
-
There are no mean of keeping the log files for more than 5 days.
895
+
There are no plan for keeping the log files for more than 5 days.
0 commit comments