Capturing a Mac Spool File

KB Home   |   Capturing a Mac Spool File

Main.MacSpoolFile History

Hide minor edits - Show changes to output

October 31, 2018, at 07:47 PM by Aaron Pouliot -
Deleted lines 3-8:

!!Save Spool Files easily with Print Archiving
If you have already enabled PaperCut's [[https://www.papercut.com/support/resources/manuals/ng-mf/common/topics/sys-archive-setting-up.html|Print Archiving]]  feature, then downloading spool files is a piece of cake.  Just make sure that this feature has already been enabled, then follow the steps below.
# Log into your PaperCut server as an administrator.
# Open '''Logs''' and find the print job of interest.
# Click on the job’s '''thumbnail''' then select the '''Download''' icon in the toolbar at the top right.
October 31, 2018, at 07:43 PM by Aaron Pouliot - Updated steps to match "Capturing A Windows Spool File"
Changed lines 3-31 from:
PaperCut Support may ask you to supply a spool file.  This is a little more difficult on the Apple Mac platform (see below for other platforms) and involves "capturing" a spool file using one of the following procedures:


!!Automated Script (recommended)

This method involves running a command/shell script
'''on the system hosting your print queues''' ''(i.e. the print server)'' to gather up required files. The procedure is:

->'''1
.''' Enable [@snapshot@] level debug logging as discussed [[https://www.papercut.com/kb/Main/HowToEnableDebugInThePrintProvider|here]].

->
'''2.''' Temporarily stop the printer, or turn off the printer so that jobs hold in the queue.

->
'''3.''' Print a job, or set of jobs that demonstrates the problem behavior.  This printing may be performed from a workstation. NB If OS X prompts you with a choice of "Cancel", "Add to Printer" or "Resume" select "Add to Printer"

->'''4
.''' Download and unzip onto the system hosting the print queues (normally the server running PaperCut), the script from here: [[ Attach:gather-files-for-papercut.zip | gather-files-for-papercut.zip ]]

->'''5.''' Copy the file to your home directory


->'''6.''' Ensure execute permissions are set on the file
.  (Command-click on the file, select ''Get info'', and set under ''Ownership & Permissions'')

->'''7.''' Double click on the [@gather-files-for-papercut.command@] file.  Enter your system password if requested (admin access is required
).

->'''8.''' Email
the file [@files-for-papercut.tgz@] found in your home directory (or if running from the command prompt your current directory) to [[mailto:support@papercut.com|PaperCut Support]]. Also include the "expected" information related to the job including:
--> - the number of pages
--> - the paper size
--> - other attributes such as grayscale, copies, etc.

->%red%If you need to capture multiple examples you must run this command (and rename the
[@files-for-papercut.tgz@]) each time. %%

to:
Sometimes when troubleshooting issues PaperCut Support may ask you to pause a print queue to make a copy of the Windows spool files used for printing.  This can help us diagnose issues related to print analysis and other problems. There are a couple methods for doing so which we've described below.

!!Save Spool Files easily with Print Archiving
If you have already enabled PaperCut's [[https://www
.papercut.com/support/resources/manuals/ng-mf/common/topics/sys-archive-setting-up.html|Print Archiving]]  feature, then downloading spool files is a piece of cake.  Just make sure that this feature has already been enabled, then follow the steps below. 
# Log into your PaperCut server as an administrator
. 
# Open
'''Logs''' and find the print job of interest.
# Click on the job’s '''thumbnail''' then select
the '''Download''' icon in the toolbar at the top right.

!!Automated Script
This method involves running a command/shell script '''on the system hosting your print queues''' ''(i.e. the print server)'' to gather up required files.
# Enable [@snapshot@] level debug logging as discussed [[https://www
.papercut.com/kb/Main/HowToEnableDebugInThePrintProvider|here]].
# Temporarily stop the printer, or turn off
the printer so that jobs hold in the queue.
# Print a job, or set of jobs that demonstrates the problem behavior
This printing may be performed from a workstation. NB If OS X prompts you with a choice of "Cancel", "Add to Printer" or "Resume" select "Add to Printer"
# Download and unzip onto the system hosting the print queues (normally the server running PaperCut
), the script from here: [[ Attach:gather-files-for-papercut.zip | gather-files-for-papercut.zip ]]
# Copy the file to your home directory. 
# Ensure execute permissions are set on the file.  (Command-click on the file, select ''Get info'', and set under ''Ownership & Permissions'')
# Double click on the [@gather-files-for-papercut.command@] file.  Enter your system password if requested (admin access is required).
#Include those files as an attachment with your
[[https://support.papercut.com|PaperCut Support Request]] and make sure you include the following details:
** the number of pages
** the paper size
** other attributes such as grayscale, copies, etc.

Changed lines 26-67 from:

'''Please use the automated method above, unless requested by support.'''

->'''1.''' Temporarily stop the printer, or turn off the printer so that jobs hold in the queue. Print a test job that demonstrates the problem behavior.

->'''2.''' Open the Terminal under Applications/Utilities

->'''3.''' Type the following in the terminal:


        mkdir ~/gatherspoolfiles
        sudo -i
        [enter your password]
        cp $(ls -t /var/spool/cups/d* | head -n 2) ~[@<username>/gatherspoolfiles@]
        exit

-->where [@<username>@] is your short login name. (i.e. this denotes the location of your home directory).

->'''4.'''You should now find at least one file in your [@~/gatherspoolfiles@] directory with a name like:
          d00077-001

->'''5.'''  Email the file(s) to [[mailto:support@papercut.com|PaperCut Support]] and also include the "expected" information related to the job including:
--> - the number of pages
--> - the paper size
--> - other attributes such as grayscale, copies, etc.

!!Windows Server Method

If you are printing from a Mac to a Windows print server the following process might be easier than the options above:

->'''1.''' On the Windows print sever temporarily pause the print queue for the printer causing problems. You can do this by right clicking on @@Start -> Printers and Faxes -> Name of the printer@@ and selecting the "Pause Printing" option.

->'''2.'''  Print a test job from the Mac to the printer that demonstrates the problem behavior.

->'''3.''' Take a copy of the spool file (*.SPL) from @@C:\WINDOWS\system32\spool\PRINTERS@@. The directory may contain a number of spool files. Copy the file whose timestamp matches the "submitted time" of the job.

->'''4.''' Rename the file such that it helps PaperCut Support and Developers to understand what should have been detected. (E.g. 5-pages.SPL)

->'''5.''' Zip and email the file to [[mailto:support@papercut.com|PaperCut Support]].

See also:

to:
We recommend using one of the methods described above. However it's also possible to gather the spool files manually by following the steps below.
# Temporarily stop the printer, or turn off the printer so that jobs hold in the queue. Print a test job that demonstrates the problem behavior.
# Open the Terminal under Applications/Utilities.
# Type the following in the terminal, substituting [@<username>@] for your short login name (which denotes the location of your home directory):
**[@
mkdir ~/gatherspoolfiles
sudo -i
[enter your password]
cp $(ls -t /var/spool/cups/d* | head -n 2) ~<username>/gatherspoolfiles
exit
@]
# You should now find at least one file in your [@~/gatherspoolfiles@] directory with a name like: @@d00077-001@@.
# Include those files as an attachment with your [[https://support.papercut.com|PaperCut Support Request]] and make sure you include the following details:
** the number of pages
** the paper size
** other attributes such as grayscale, copies, etc.

!! Related Articles
Added lines 49-51:
!!Need a hand?
Let us know! We love chatting about what’s going on under the hood, and we're happy to help out when needed. Contact your PaperCut Authorized Solutions Center or head over to [[https://support.papercut.com|Support Portal]] for further assistance.

Changed line 55 from:
[-keywords: mac print to file, apple, macos  -]
to:
[-keywords: mac print to file, apple, macOS  -]
October 30, 2018, at 12:59 AM by JasonC - Keyword
Changed line 83 from:
[-keywords: mac print to file, apple,  -]
to:
[-keywords: mac print to file, apple, macos  -]
Deleted lines 23-24:
->%red%If you need to capture multiple examples you must run this command (and rename the [@files-for-papercut.tgz@]) each time. %%
Added lines 28-29:

->%red%If you need to capture multiple examples you must run this command (and rename the [@files-for-papercut.tgz@]) each time. %%
September 25, 2015, at 03:25 AM by jason - clarify running the script multiple times.
Added lines 23-24:

->%red%If you need to capture multiple examples you must run this command (and rename the [@files-for-papercut.tgz@]) each time. %%
January 30, 2014, at 04:14 AM by Alec - Fixed OS X bug
Added line 41:
       mkdir ~/gatherspoolfiles
Changed line 44 from:
       cp $(ls -t /var/spool/cups/d* | head -2) ~[@<username>@]
to:
       cp $(ls -t /var/spool/cups/d* | head -n 2) ~[@<username>/gatherspoolfiles@]
Changed line 49 from:
->'''4.'''You should now find at least one file in your home directory with a name like:
to:
->'''4.'''You should now find at least one file in your [@~/gatherspoolfiles@] directory with a name like:
Changed lines 14-15 from:
->'''3.''' Print a job, or set of jobs that demonstrates the problem behavior.  This printing may be performed from a workstation. NB If OS X prompts you with a choice of "Cancel", "Add to Printer" or "Resume Printer" select "Add to Printer"
to:
->'''3.''' Print a job, or set of jobs that demonstrates the problem behavior.  This printing may be performed from a workstation. NB If OS X prompts you with a choice of "Cancel", "Add to Printer" or "Resume" select "Add to Printer"
December 19, 2012, at 05:32 AM by Alec - Fixed couple of errors and simplified the manual process
Changed lines 14-15 from:
->'''3.''' Print a job, or set of jobs that demonstrates the problem behavior.  This printing may be performed from a workstation.
to:
->'''3.''' Print a job, or set of jobs that demonstrates the problem behavior.  This printing may be performed from a workstation. NB If OS X prompts you with a choice of "Cancel", "Add to Printer" or "Resume Printer" select "Add to Printer"
Changed line 24 from:
->'''8.''' Email the file [@files-for-papercut.tgz@] found in your home directory to [[mailto:support@papercut.com|PaperCut Support]]. Also include the "expected" information related to the job including:
to:
->'''8.''' Email the file [@files-for-papercut.tgz@] found in your home directory (or if running from the command prompt your current directory) to [[mailto:support@papercut.com|PaperCut Support]]. Also include the "expected" information related to the job including:
Changed line 41 from:
       sudo su -
to:
       sudo -i
Changed line 43 from:
       cp `ls -t /var/spool/cups/d* | head -2` /Users/<username>
to:
       cp $(ls -t /var/spool/cups/d* | head -2) ~[@<username>@]
Changed lines 46-47 from:
-->where [@<username>@] is your short login name. (i.e. this denotes the location of your home directory).  '''Special Note:''' the character preceding the [@ls@] and following the [@2@] is a back-tick ([@`@]).
to:
-->where [@<username>@] is your short login name. (i.e. this denotes the location of your home directory).
November 09, 2012, at 04:22 AM by ian - add e-mail links, see also
Changed lines 3-5 from:
PaperCut Support may ask you to supply a print-to-file.  This is a little more difficult on the Apple Mac platform  (see [[CapturingALinuxSpoolFile|here for Linux]])  and involves "capturing" a spool file using one of the following procedures:

to:
PaperCut Support may ask you to supply a spool file.  This is a little more difficult on the Apple Mac platform (see below for other platforms) and involves "capturing" a spool file using one of the following procedures:

Changed line 24 from:
->'''8.''' Email the file [@files-for-papercut.tgz@] found in your home directory. Also include the "expected" information related to the job including:
to:
->'''8.''' Email the file [@files-for-papercut.tgz@] found in your home directory to [[mailto:support@papercut.com|PaperCut Support]]. Also include the "expected" information related to the job including:
Changed line 51 from:
->'''5.'''  email the file(s) to support and also include the "expected" information related to the job including:
to:
->'''5.'''  Email the file(s) to [[mailto:support@papercut.com|PaperCut Support]] and also include the "expected" information related to the job including:
Changed lines 66-69 from:
->'''4.''' Rename the file such that it helps the developers to understand what should have been detected. (E.g. 5-pages.SPL)

->'''5.''' Zip and email the file to support.
to:
->'''4.''' Rename the file such that it helps PaperCut Support and Developers to understand what should have been detected. (E.g. 5-pages.SPL)

->'''5.''' Zip and email the file to [[mailto:support@papercut.com|PaperCut Support]].

See also:

* [[PageCountProblems|+]]
* [[CapturingAWindowsSpoolFile|+]]
* [[CapturingALinuxSpoolFile|+]]
* [[CapturingANovellSpoolFile|+]]

Changed line 80 from:
[-keywords: mac print to file, apple,  -]
to:
[-keywords: mac print to file, apple,  -]
Changed lines 1-2 from:
(:title Capturing a Mac spool file:) 
to:
(:title Capturing a Mac Spool File:) 
Changed lines 12-22 from:
->'''2.''' Temporarily stop the printer, or turn off the printer so that jobs hold in the queue. Print a job, or set of jobs that demonstrates the problem behavior.  This printing may be performed from a workstation.

->'''3.''' Download and unzip onto the system hosting the print queues (normally the server running PaperCut), the script from here: [[ Attach:gather-files-for-papercut.zip | gather-files-for-papercut.zip ]]

->'''4.''' Copy the file to your home directory. 

->'''5.''' Ensure execute permissions are set on the file.  (Command-click on the file, select ''Get info'', and set under ''Ownership & Permissions'')

->'''6.''' Double click on the [@gather-files-for-papercut.command@] file.  Enter your system password if requested (admin access is required).

->'''7.''' Email the file [@files-for-papercut.tgz@] found in your home directory. Also include the "expected" information related to the job including:
to:
->'''2.''' Temporarily stop the printer, or turn off the printer so that jobs hold in the queue.

->'''3.'''
Print a job, or set of jobs that demonstrates the problem behavior.  This printing may be performed from a workstation.

->'''4.''' Download and unzip onto the system hosting the print queues (normally the server running PaperCut), the script from here: [[ Attach:gather-files-for-papercut.zip | gather-files-for-papercut.zip ]]

->'''5.''' Copy the file to your home directory. 

->'''6.''' Ensure execute permissions are set on the file.  (Command-click on the file, select ''Get info'', and set under ''Ownership & Permissions'')

->'''7.''' Double click on the [@gather-files-for-papercut.command@] file.  Enter your system password if requested (admin access is required).

->'''8.''' Email the file [@files-for-papercut.tgz@] found in your home directory. Also include the "expected" information related to the job including:
Changed lines 6-7 from:
!!Automated Script
to:
!!Automated Script (recommended)
Added lines 30-31:
'''Please use the automated method above, unless requested by support.'''
June 02, 2010, at 11:33 PM by Tim - fix typo s/how/now/
Changed line 44 from:
->'''4.'''You should how find at least one file in your home directory with a name like:
to:
->'''4.'''You should now find at least one file in your home directory with a name like:
May 11, 2010, at 05:52 AM by 202.129.124.120 -
Changed lines 3-5 from:
PaperCut Support may ask you to supply a print-to-file.  This is a little more difficult on the Apple Mac platform  (also applies to Linux)  and involves "capturing" a spool file using one of the following procedures:

to:
PaperCut Support may ask you to supply a print-to-file.  This is a little more difficult on the Apple Mac platform  (see [[CapturingALinuxSpoolFile|here for Linux]])  and involves "capturing" a spool file using one of the following procedures:

Changed lines 10-20 from:
->'''1.''' Temporarily stop the printer, or turn off the printer so that jobs hold in the queue. Print a job, or set of jobs that demonstrates the problem behavior.  This printing may be performed from a workstation.

->'''2.''' Download and unzip onto the system hosting the print queues (normally the server running PaperCut), the script from here: [[ Attach:gather-files-for-papercut.zip | gather-files-for-papercut.zip ]]

->'''3.''' Copy
the file to your home directory. 

->'''4.''' Ensure execute permissions are set on the file. (Command-click on the file, select ''Get info'', and set under ''Ownership & Permissions'')

->'''5.''' Double click on the [@gather-files-for-papercut.command@] file.  Enter your system password if requested (admin access is required).

->'''6.''' Email the file [@files-for-papercut.tgz@] found in your home directory. Also include the "expected" information related to the job including:
to:
->'''1.''' Enable [@snapshot@] level debug logging as discussed [[https://www.papercut.com/kb/Main/HowToEnableDebugInThePrintProvider|here]].

->'''2.''' Temporarily stop the printer, or turn off the printer so that jobs hold in the queue. Print a job, or set of jobs that demonstrates the problem behavior.  This printing may be performed from a workstation.

->'''3.''' Download and unzip onto the system hosting the print queues (normally the server running PaperCut), the script from here: [[ Attach:gather-files-for-papercut.zip | gather-files-for-papercut.zip ]]

->'''4.''' Copy the file to your home directory. 

->'''5.''' Ensure execute permissions are set on the file.  (Command-click on the file, select ''Get info'', and set under ''Ownership & Permissions'')

->'''6.''' Double click on the [@gather-files-for-papercut.command@] file.  Enter your system password if requested (admin access is required).

->'''7
.''' Email the file [@files-for-papercut.tgz@] found in your home directory. Also include the "expected" information related to the job including:
Changed lines 3-5 from:
PaperCut Support may ask you to supply a print-to-file.  This is a little more difficult on the Apple Mac platform and involves "capturing" a spool file using one of the following procedures:

to:
PaperCut Support may ask you to supply a print-to-file.  This is a little more difficult on the Apple Mac platform  (also applies to Linux) and involves "capturing" a spool file using one of the following procedures:

Changed lines 12-13 from:
->'''2.''' Download and unzip onto the system hosting the print queues, the script from here: [[ Attach:gather-files-for-papercut.zip | gather-files-for-papercut.zip ]]
to:
->'''2.''' Download and unzip onto the system hosting the print queues (normally the server running PaperCut), the script from here: [[ Attach:gather-files-for-papercut.zip | gather-files-for-papercut.zip ]]
April 10, 2008, at 01:19 AM by 218.214.136.161 -
Changed lines 60-61 from:
->'''4.''' Zip and email the file to support.
to:
->'''4.''' Rename the file such that it helps the developers to understand what should have been detected. (E.g. 5-pages.SPL)

->'''5
.''' Zip and email the file to support.
April 10, 2008, at 01:17 AM by 218.214.136.161 -
Changed lines 52-53 from:
If you are printing from a Mac to a Windows print server and you are having printer problems please follow the steps listed below to send us the spool file:
to:
If you are printing from a Mac to a Windows print server the following process might be easier than the options above:
Changed lines 58-59 from:
->'''3.''' Capture the spool file(*.SPL) from @@C:\WINDOWS\system32\spool\PRINTERS@@. The timestamp of the file should match the "submitted time" of the job in the Windows printer queue screen.
to:
->'''3.''' Take a copy of the spool file (*.SPL) from @@C:\WINDOWS\system32\spool\PRINTERS@@. The directory may contain a number of spool files. Copy the file whose timestamp matches the "submitted time" of the job.
Changed line 61 from:
 
to:
April 10, 2008, at 01:13 AM by 218.214.136.161 -
Changed lines 52-53 from:
If you print from a mac on a Windows server follow the steps listed here:
to:
If you are printing from a Mac to a Windows print server and you are having printer problems please follow the steps listed below to send us the spool file:

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 October 31, 2018, at 07:47 PM
Printable View   |   Article History   |   Edit Article