docs/nspr/creating_a_cookie_log.rst

   1 Creating a cookie log
   2 =====================
   3
   4 Creating a cookie log is often necessary to troubleshoot problems with
   5 Firefox's cookie handling. If you are reading this, you have probably
   6 been directed here from a bug report. Please follow the instructions
   7 below to run Firefox with cookie logging enabled.
   8
   9 .. _Enabling_Cookie_Logging:
  10
  11 Enabling Cookie Logging
  12 ~~~~~~~~~~~~~~~~~~~~~~~
  13
  14 Windows
  15 ^^^^^^^
  16
  17 Open a command prompt (this is under Programs or Programs/Accessories in
  18 normal installations of Windows).
  19
  20 #. Change to your Firefox directory (usually C:\Program Files\Mozilla
  21    Firefox)
  22 #. Type "set NSPR_LOG_FILE=C:\temp\cookie-log.txt", enter
  23 #. Type "set NSPR_LOG_MODULES=cookie:4" and press Enter
  24 #. Run Firefox by typing "firefox.exe" and pressing Enter.
  25
  26 Linux
  27 ^^^^^
  28
  29 Start a command shell (these instructions are for bash, if you use
  30 something else, you probably know how to modify these instructions
  31 already).
  32
  33 #. Change to the installation directory for Firefox.
  34 #. Type "export NSPR_LOG_FILE=~/cookie-log.txt" and press Enter.
  35 #. Type "export NSPR_LOG_MODULES=cookie:4" and press Enter.
  36 #. Run Firefox by typing "./firefox" and pressing Enter
  37
  38 macOS
  39 ^^^^^
  40
  41 Open Terminal.app, which is located in the /Applications/Utilities
  42 folder (these instructions are for bash, the default shell in macOS
  43 10.3 and higher; if you use something else, you probably know how to
  44 modify these instructions already).
  45
  46 #. Change to the installation directory for Firefox, e.g. type "cd
  47    /Applications/Firefox.app/Contents/MacOS" and press Return.
  48 #. Type "export NSPR_LOG_FILE=~/Desktop/cookie-log.txt" and press
  49    Return.
  50 #. Type "export NSPR_LOG_MODULES=cookie:4" and press Return.
  51 #. Run Firefox by typing "./firefox" and pressing Return (note that
  52    Firefox will launch behind windows for other applications).
  53
  54 Creating the Log
  55 ~~~~~~~~~~~~~~~~
  56
  57 Now that you have Firefox running with logging enabled, please try to
  58 replicate the bug using the steps to reproduce from the bug report. Once
  59 you have reproduced the bug, shut down Firefox. Close out of the command
  60 prompt/shell/Terminal, and then launch Firefox normally. Finally, attach
  61 the cookie-log.txt file to the bug where it was requested (by clicking
  62 on Create New Attachment). It should be in C:\temp on Windows, your home
  63 directory on Linux, or the Desktop on Mac OS X.
  64
  65 Thanks for helping us make Firefox better!