How to Enable Debug in the User Client
Last modified on 11 August 2020 09:11 PM
PaperCut has special debug options which cause PaperCut to produce a detailed text log of activity. The logs allow our developers to inspect the internal workings of the PaperCut application and pinpoint the cause of problems. Enabling debug logging is usually only requested by the PaperCut Support team.
The User Client is the component of PaperCut that runs on the user workstations. Its purpose is to display the Balance Window, allow job (cost) confirmation, allow charging to shared accounts, and in some cases perform authentication.
Tip: If you’re seeing mysterious behavior with the User Client, but not getting any error messages, check to see if the User Client has been configured to use the —silent option, which suppresses all error messages. Try running the client without this option, and see if the client then gives you any useful error message information first!
Note: There are two ways to enable debug logging: via the config file, or via a launch parameter. If the client is being launched from a network share (e.g. running
1A. Enabling debug via the config file:
On the system where the user client is installed, open the file:
in a text editor.
You’ll find the Mac client config file at
Add a line
1B. Enabling debug via the launch parameter:
From the place where the client is launched (e.g. the ‘Startup’ folder, a login script, etc.), add the parameter
If the command is quoted, the parameter should be added outside the quotes, separated by a space, e.g., on Windows:
2. Restart the user client tool.
3. Reproduce the error.
4. Compress (“zip up”) the resulting log file
On Windows XP (or earlier) systems it can be found at:
On Windows 10, Windows 8, Windows 7 or Windows Vista systems it can be found at:
On Mac systems, it can be found in the user’s home directory:
On Linux systems, it can be found in the standard temporary directory:
5. Send the compressed log file to support. Include an explanation of the steps taken, along with any other information requested by the PaperCut developers such as event time, logged in user, workstation name. By the way: your log files and other information you send to us will be treated with care in accordance
6. Turn off debug logging by reversing the tasks undertaken in step 1A/B.