How to Enable Debug in the User Client

KB Home   |   How to Enable Debug in the User Client

Main.HowToEnableDebugInTheUserClient History

Hide minor edits - Show changes to output

March 27, 2019, at 04:32 AM by timg - Added --silent tip
Added lines 8-9:

'''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 [[https://www.papercut.com/support/resources/manuals/ng-mf/common/topics/tools-user-client.html|--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!
March 07, 2019, at 04:57 AM by timg - Privacy update
Changed line 49 from:
->'''5.''' Email the compressed log file to support@papercut.com.  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.
to:
->'''5.''' Send the compressed log file to [[https://support.papercut.com|support.papercut.com]]. 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 with our [[https://www.papercut.com/privacy-policy/|privacy policy]].
August 10, 2017, at 12:57 PM by Matthew Lee - Typo in article. "Windows 10"
Changed line 40 from:
-->On  "Windows 10",''Windows 8'', ''Windows 7''  or ''Windows Vista'' systems it can be found at:
to:
-->On  ''Windows 10'', ''Windows 8'', ''Windows 7''  or ''Windows Vista'' systems it can be found at:
Changed line 40 from:
-->On ''Windows 8'', ''Windows 7'' or ''Windows Vista'' systems it can be found at:
to:
-->On  "Windows 10",''Windows 8'', ''Windows 7'' or ''Windows Vista'' systems it can be found at:
December 03, 2014, at 06:57 AM by Shane higgins -
November 27, 2014, at 05:20 AM by 203.222.91.204 -
Changed line 18 from:
You'll find the Mac client config file at [@[app-path]/client/mac/PCClient/Contents/Resources/config.properties@].  To browse inside the [@PCClient@] package option-click it and choose ''Show Package Contents''.
to:
You'll find the Mac client config file at [@[app-path]/client/mac/PCClient.app/Contents/Resources/config.properties@].  To browse inside the [@PCClient@] package option-click it and choose ''Show Package Contents''.
Changed lines 29-30 from:
-->[-[@"C:\Program Files\PaperCut\client\win\pc-client-local-cache.exe" --debug@]-]
to:
-->[@"C:\Program Files\PaperCut\client\win\pc-client-local-cache.exe" --debug@]
March 13, 2014, at 05:17 PM by TimG - Making smaller text larger from the instructions to match the rest
Changed line 18 from:
[-You'll find the Mac client config file at [@[app-path]/client/mac/PCClient/Contents/Resources/config.properties@].  To browse inside the [@PCClient@] package option-click it and choose ''Show Package Contents''.-]
to:
You'll find the Mac client config file at [@[app-path]/client/mac/PCClient/Contents/Resources/config.properties@].  To browse inside the [@PCClient@] package option-click it and choose ''Show Package Contents''.
Changed line 28 from:
[-If the command is quoted, the parameter should be added '''outside the quotes''', separated by a space, e.g., on Windows:-]
to:
If the command is quoted, the parameter should be added '''outside the quotes''', separated by a space, e.g., on Windows:
Changed lines 51-52 from:
->'''6.''' Turn off debug logging by reversing the tasks undertaken in ''step 2''.
to:
->'''6.''' Turn off debug logging by reversing the tasks undertaken in ''step 1A/B''.
Changed line 40 from:
-->On ''Windows 7'' or ''Windows Vista'' systems it can be found at:
to:
-->On ''Windows 8'', ''Windows 7'' or ''Windows Vista'' systems it can be found at:
Changed lines 5-6 from:
PaperCut has special '''debug options''' which cause 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 debug logging is only usually required of requested by the PaperCut Support team.
to:
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.
Changed line 56 from:
[-Keywords: user client tool, UIT, user interface tool, balance window, diagnostic, credit display-]
to:
[-Keywords: user client tool, UIT, user interface tool, balance window, diagnostic, credit display-]
Added line 26:
-->The [@pc-client-local-cache.exe@] client requires the debug parameter method, not the config file modification.
Deleted lines 27-28:
-->The [@pc-client-local-cache.exe@] client requires the debug parameter method, not the config file modification.
-->\\
Added lines 27-28:
-->The [@pc-client-local-cache.exe@] client requires the debug parameter method, not the config file modification.
-->\\
Changed lines 5-6 from:
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.
to:
PaperCut has special '''debug options''' which cause 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 debug logging is only usually required of requested by the PaperCut Support team.
October 18, 2010, at 02:47 AM by Tim - user-client.log is not in user home directory - rather the /tmp dir
Changed lines 45-47 from:
-->On ''Linux'' systems, it can be found in the user's home directory:
--->typically [@/home/[username]/user-client.log@]
to:
-->On ''Linux'' systems, it can be found in the standard temporary directory:
--->typically [@/tmp/user-client.log@]
September 28, 2010, at 12:30 AM by Rick - changed phrasing, added keyword
Changed lines 7-8 from:
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.
to:
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.
Changed lines 48-49 from:
->'''5.''' 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.
to:
->'''5.''' Email the compressed log file to support@papercut.com.  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.
Changed line 55 from:
[-Keywords: user client tool, UIT, user interface tool, balance window, credit display-]
to:
[-Keywords: user client tool, UIT, user interface tool, balance window, diagnostic, credit display-]
Changed lines 34-35 from:
->'''4.''' Compress ''("zip up")'' the resulting log file @@user-client.log@@.
to:
->'''4.''' Compress ''("zip up")'' the resulting log file @@user-client.log@@ (and @@pc-client-local-cache.log@@ if using [@pc-client.local.cache.exe@]).
Changed lines 36-38 from:
-->On ''Windows'' systems, it can be found at:
--->@@C:\Documents and Settings\[username]\Local Settings\Temp\user-client.log@@
to:
-->On ''Windows XP'' (or earlier) systems it can be found at:
--->[@C:\Documents and Settings\[username]\Local Settings\Temp\user-client.log@]

-->On ''Windows 7'' or ''Windows Vista'' systems it can be found at:
--->[
@C:\Users\[username]\AppData\Local\Temp\user-client.log@]
Changed lines 43-44 from:
--->@@/Users/[username]/user-client.log@@
to:
--->[@/Users/[username]/user-client.log@]
Changed lines 46-47 from:
--->typically @@/home/[username]/user-client.log@@
to:
--->typically [@/home/[username]/user-client.log@]
Changed lines 3-4 from:
''Please also see [[ReportingProblems | +]]''
to:
''Please also see [[ReportingProblems|+]]''
Changed lines 9-10 from:
'''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:
'''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 @@pc-client-local-cache.exe@@ or @@pc-client.exe@@ from the [@PCClient@] share on the server) then enabling debug in the config file will enable it for '''all users launching the client from that location'''.  In that case, and if debug logging is only required for one workstation, enabling it via the launch parameter may be more suitable.
Changed lines 13-14 from:
->1. '''On the system where the user client is installed''', open the file:
-->[@[app-dir]/client/[platform]/config.properties@]
to:
->'''1A. Enabling debug via the config file:'''
--> '''On the system where the user client is installed''', open the file:
-->[@[app-path]/client/[platform]/config.properties@]
Changed lines 17-26 from:
-->[-(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@@.
to:
-->\\
[-You'll find the Mac client config file at [@[app-path]/client/mac/PCClient/Contents/Resources/config.properties@].  To browse inside the [@PCClient@] package option-click it and choose ''Show Package Contents''.-]
-->\\
Add a line [@debug=Y@] to
the end and save the file (or remove the [@#@] comment from the existing line).

'''OR'''

->'''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 [@--debug@] to the end of the command/target (ensuring there is a space between the command and the parameter).
-->\\
[-If the command is quoted, the parameter should be added '''outside the quotes''', separated by a space, e.g., on Windows:-]
-->[-[@"C:\Program Files\PaperCut\client\win\pc-client-local-cache.exe" --debug@]-]

->'''2.''' Restart the user client tool.

->'''3.''' Reproduce the error.

->'''4.'''
Compress ''("zip up")'' the resulting log file @@user-client.log@@.
Changed lines 45-48 from:
->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''.
to:
->'''5.''' 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.

->'''6.''' Turn off debug logging by reversing the tasks undertaken in ''step 2''.
Changed line 40 from:
''Categories:'' [[!Troubleshooting]]
to:
''Categories:'' [[Category.Debugging|+]], [[Category.Troubleshooting|+]]
Changed lines 16-17 from:
-->[-(on the Mac, you'll find this inside the package at [@PCClient.app/Contents/Resources/@])-]
to:
-->[-(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...'')-]

Comments

Share your findings and experience with other PaperCut users. Feel free to add comments and suggestions about this Knowledge Base article. Please don't use this for support requests.

Article last modified on March 27, 2019, at 04:32 AM
Printable View   |   Article History   |   Edit Article