forked from pwndbg/pwndbg
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added Document on Environment Variabes (pwndbg#2198)
Co-authored-by: B1N4RY-P4R45173 <[email protected]>
- Loading branch information
1 parent
6937566
commit cfeba7c
Showing
1 changed file
with
17 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
## Environment Variables | ||
|
||
Pwndbg relies on several environment variables to customize its behavior. Below is a list of these variables and their purposes: | ||
|
||
- `PATH`: Standard system `PATH` variable used to locate executables. | ||
- `EDITOR`, `VISUAL`: Used by the `cymbol` command to open an editor. | ||
- `HOME`, `XDG_CACHE_HOME`: Used by `lib.tempfile` to determine temporary file locations. | ||
- `PWNDBG_VENV_PATH`: Specifies the virtual environment path for Pwndbg. | ||
- `PWNDBG_DISABLE_COLORS`: Disables colored output in Pwndbg. | ||
- `OPENAI_API_KEY`, `ANTHROPIC_API_KEY`: Used by the `ai` command for accessing respective AI APIs. | ||
- `GITHUB_ACTIONS`, `RUN_FLAKY`: Used by `tests_commands.py` to determine the test environment. | ||
- `PWNDBG_PROFILE`: Enables profiling for benchmarking. | ||
- `USE_PDB`: Enables Python debugger in tests. | ||
- `PWNDBG_LAUNCH_TEST`: Used by tests to configure test launching. | ||
- `PWNDBG_ARCH`, `PWNDBG_KERNEL_TYPE`, `PWNDBG_KERNEL_VERSION`: Used by `gdblib` kernel tests to specify kernel parameters. | ||
- `SPHINX`: Used by `docs/source/conf.py`, likely to be removed. | ||
- `PWNLIB_NOTERM=1`: Set by Pwndbg to avoid terminal issues with Pwntools. |