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
+92Lines changed: 92 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,6 +29,9 @@ This manual includes a description of the system functionalities and capabilitie
29
29
*[Run an application with parameters](#run-an-application-with-parameters)
30
30
*[Open a command prompt in directory](#open-a-command-prompt-in-directory)
31
31
*[Select two files for an operation](#select-two-files-for-an-operation)
32
+
*[Troubleshooting](#troubleshooting)
33
+
*[Logging support](#logging-support)
34
+
*[Reporting bugs](#reporting-bugs)
32
35
33
36
34
37
@@ -812,3 +815,92 @@ The following xml sample can select two files for an operation :
812
815
</shell>
813
816
</root>
814
817
```
818
+
819
+
820
+
821
+
822
+
# Troubleshooting #
823
+
824
+
825
+
826
+
## Logging support ##
827
+
828
+
ShellAnything provides logging support for troubleshooting and debugging commands.
829
+
830
+
831
+
832
+
### Location ###
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`.
836
+
837
+
838
+
839
+
### Filename Format ###
840
+
841
+
The log files names are generated in the following format:
842
+
`<name>.<LEVEL>.<date>-<time>.<pid>.log`.
843
+
844
+
The following table defines each field identifier in the filename format:
| name | Matches the name of the dll that generates log messages. Usually `shellext.dll`. |
849
+
| LEVEL | The logging level. Accepted values are `ERROR`, `WARNING` and `INFO`. See [glog documentation](https://github.com/google/glog/blob/v0.4.0/doc/glog.html) for details. |
850
+
| date | The current date when the file was created in `yyyymmdd` format. |
851
+
| time | The current date when the file was created in `hhmmss` format. |
852
+
| pid | The Process Id which generates the log message. |
853
+
854
+
For example, the following filename is a valid log file format:
855
+
`shellext.dll.INFO.20191125-083305.9456.log`
856
+
857
+
858
+
859
+
### Levels ###
860
+
861
+
The logging library used by ShellAnything is [Google's logging module (glog)](https://github.com/google/glog).
862
+
863
+
All messages logged by the application have an associated level to describe the severity of the message.
864
+
865
+
The application supports 3 differents logging levels: `ERROR`, `WARNING` and `INFO`. See [glog documentation](https://github.com/google/glog/blob/v0.4.0/doc/glog.html) for details.
866
+
867
+
Each level have a dedicated log file for storing messages. For example:
868
+
```
869
+
shellext.dll.INFO.20191125-083305.9456.log
870
+
shellext.dll.WARNING.20191125-083701.9456.log
871
+
shellext.dll.ERROR.20191125-084152.9456.log
872
+
```
873
+
See [Filename Format](#filename-format) for details.
874
+
875
+
Each log file contains the messages at it's matching level but also the messages with a higher severity.
876
+
In other words, all logs messages are available in the INFO log file, including messages logged with WARNING and ERROR levels.
877
+
878
+
The ERROR log file contains all messages with ERROR level.
879
+
The WARNING log file contains all messages with ERROR and WARNING levels.
880
+
The INFO log file contains all messages with ERROR, WARNING and INFO levels.
881
+
882
+
Debugging log messages are only available in debug builds of the application.
883
+
884
+
885
+
886
+
### Log files life cycle###
887
+
888
+
The log files are kept for a maximum of 5 days.
889
+
890
+
On application startup, the existing log files are all validated and files older than 5 days are deleted.
891
+
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.
897
+
898
+
There are no mean of keeping the log files for more than 5 days.
899
+
900
+
901
+
902
+
## Reporting bugs ##
903
+
904
+
If you find any issues while using ShellAnything, please report your findings using the [project issue page on GitHub](https://github.com/end2endzone/ShellAnything/issues).
905
+
906
+
Improvements to the software are also welcome and can be proposed using the same method.
0 commit comments