Knowledge Base

How to Enable Debug in the User Client

Please also see Reporting Problems

The enable debug option causes PaperCut to produce a detailed text log of activity. The log allows our developers to inspect the internal workings of the PaperCut application and pinpoint the cause of problems. Enabling debugging is only usually required if 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 to the user their balance, allow charging to shared accounts, and in some cases perform authentication.

Note: The user client can be installed using a number of methods, including the zero-install method of running it directly from the network. If the user client is running from the network, it will need to be installed locally on a system for the duration of enabling debug. It is possible to enable debug by editing the config.properties file on the server's PCClient network share, but this would enable debug for every user, and may create a lot of debugging output.

To enable debug in the PaperCut User Client:

1. On the system where the user client is installed, open the file:
[app-dir]/client/[platform]/config.properties
in a text editor.
(on the Mac, you'll find this inside the package at PCClient.app/Contents/Resources/ . Option-click on the icon and select Show package contents...)
2. Add a line debug=Y to the end and save the file (or remove the # comment from the existing line).
3. Restart the user client tool.
4. Reproduce the error.
5. Compress ("zip up") the resulting log file user-client.log.
On Windows systems, it can be found at:
C:\Documents and Settings\[username]\Local Settings\Temp\user-client.log
On Mac systems, it can be found in the user's home directory:
/Users/[username]/user-client.log
On Linux systems, it can be found in the user's home directory:
typically /home/[username]/user-client.log
6. Email the compressed log file to support@papercut.com. Include an explanation of the steps taken, along with any other information such as event time requested by the PaperCut developers.
7. Turn off debug logging by reversing the tasks undertaken in step 2.

Categories: Debugging, Troubleshooting

Keywords: user client tool, UIT, user interface tool, balance window, credit display

Page last modified on February 03, 2008, at 10:59 PM