Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
debug_output [2021/03/16 12:26] – [Logging to a Terminal Window] dstillmandebug_output [2023/12/26 02:04] (current) – [Zotero for iOS] dstillman
Line 5: Line 5:
 ==== Zotero ==== ==== Zotero ====
  
-  - In the Help menu, go to Debug Output Logging and select Enable, or use "Restart with Logging Enabled…" to generate debug output from Zotero startup. (If you're not able to access the Help menu, see [[reporting_problems#reporting_startup_errors|Reporting Startup Errors]] instead.)+  - In the Help menu, go to Debug Output Logging and select Enable, orto generate debug output from Zotero startup, select "Restart with Logging Enabled…". (If you're not able to access the Help menu, see [[reporting_problems#reporting_startup_errors|Reporting Startup Errors]] instead.)
   - Immediately perform the relevant action (syncing, saving, importing, etc.) and reproduce the problem you're experiencing.   - Immediately perform the relevant action (syncing, saving, importing, etc.) and reproduce the problem you're experiencing.
   - Before doing anything else, return to Help -> Debug Output Logging and click Submit Output, which will disable logging and submit the output to zotero.org. A window should pop up containing a Debug ID (e.g., “D12345678”). Click "Copy to Clipboard" and paste the Debug ID into your forum thread.   - Before doing anything else, return to Help -> Debug Output Logging and click Submit Output, which will disable logging and submit the output to zotero.org. A window should pop up containing a Debug ID (e.g., “D12345678”). Click "Copy to Clipboard" and paste the Debug ID into your forum thread.
 +
 +If submitting output fails, you can return to the Debug Output Logging menu and select View Output, go to File -> "Save…", choose Format: "Text Files", and save the output to a file, which you can email to support@zotero.org with a link to your forum thread. It can be helpful to ZIP the file before emailing it.
  
 ==== Zotero Connectors (Firefox, Chrome, and Safari) ==== ==== Zotero Connectors (Firefox, Chrome, and Safari) ====
Line 20: Line 22:
   - Uncheck the box next to "Enable Logging."   - Uncheck the box next to "Enable Logging."
  
 +==== Zotero for iOS ====
  
-==== Error Submitting a Debug Log ====+  - Tap Back in the top-left corner until you see the list of libraries. 
 +  - Tap the Gear icon. 
 +  - Tap "Debug Output Logging" and then "Start Logging"
 +  - Close the settings window. 
 +  - Immediately perform all relevant actions (e.g., pulling down on the items list to trigger sync or switching to the browser and trying to save). 
 +  - When you're done, tap the circular stop button in the bottom-left corner of the screen. 
 +  - In the alert that pops up, tap Copy to copy the Debug ID to the clipboard, and then paste it into your forum thread.
  
-If submitting output failsyou can return to the Debug Output Logging menu and select View Output, go to File -> "Save…", choose Format: "Text Files", and save the output to a file, which you can email to support@zotero.org with a link to your forum threadIt can be helpful to ZIP the file before emailing it.+==== Zotero for Android ==== 
 + 
 +  - From the items listtap Collections in the top-left corner and then Libraries. 
 +  - Tap the Gear icon. 
 +  - Tap "Debug Output Loggingand then "Start Logging"
 +  - Close the settings window. 
 +  - Immediately perform all relevant actions (e.g.pulling down on the items list to trigger sync or switching to the browser and trying to save). 
 +  - When you're done, tap the circular stop button in the bottom-left corner of the screen. 
 +  - In the alert that pops up, tap Copy to copy the Debug ID to the clipboard, and then paste it into your forum thread.
  
 ===== Logging to a Terminal Window ====== ===== Logging to a Terminal Window ======
Line 31: Line 48:
 ==== macOS ==== ==== macOS ====
  
-  * Open Terminal via Spotlight or /Applications/Utilities.+  * Open Terminal via Spotlight or from /Applications/Utilities.
   * Paste ''/Applications/Zotero.app/Contents/MacOS/zotero -ZoteroDebugText'' into the Terminal window.   * Paste ''/Applications/Zotero.app/Contents/MacOS/zotero -ZoteroDebugText'' into the Terminal window.
   * Press Return   * Press Return
  
 +You can add '' > ~/Desktop/zotero-debug.txt'' to the end of the command to redirect the output to a file on your desktop.
 ==== Windows ==== ==== Windows ====
  
-  * Open cmd.exe +  * Open cmd.exe, Cygwin shell, or another terminal 
-  * Paste ''"C:\Program Files (x86)\Zotero\zotero.exe" -ZoteroDebugText -console'' into the console window.+  * Paste ''%%"C:\Program Files (x86)\Zotero\zotero.exe"%% -ZoteroDebugText'' into the console window. In some cases ''-console'' may also be required.
   * Press Enter.   * Press Enter.
  
-Due to limitations of the available console windows on Windows, we recommend starting with ''-ZoteroDebug'' instead to use Zotero's internal debug output window+Due to limitations of the available console windows on Windows, you may have a better experience using ''-ZoteroDebug'' instead to use Zotero's internal debug output window.
- +
-To capture output when Zotero is crashing or hanging, you can use ''-ZoteroDebugText > file.txt'' to redirect output to a file.+
  
 ==== Linux ==== ==== Linux ====
  
 Start Zotero via the command line, adding the ''-ZoteroDebugText'' command-line flag. Start Zotero via the command line, adding the ''-ZoteroDebugText'' command-line flag.
 +
 +To capture output when Zotero is crashing or hanging, you can use ''-ZoteroDebugText > zotero-debug.txt'' to redirect output to a file.
  
 === Developer Note === === Developer Note ===
  
 To enable Zotero debug output permanently, set extensions.zotero.debug.log to true in the Zotero config editor, accessible from the Advanced pane of the Zotero preferences, and then start Zotero from the command line. To enable Zotero debug output permanently, set extensions.zotero.debug.log to true in the Zotero config editor, accessible from the Advanced pane of the Zotero preferences, and then start Zotero from the command line.
debug_output.1615912018.txt.gz · Last modified: 2021/03/16 12:26 by dstillman