Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Describe and map in documentation all the environment variables #4445

Open
wargio opened this issue Apr 18, 2024 · 8 comments
Open

Describe and map in documentation all the environment variables #4445

wargio opened this issue Apr 18, 2024 · 8 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@wargio
Copy link
Member

wargio commented Apr 18, 2024

Many environment variables are not mapped in any documentation and only there in the source code.

We should probably map them in the book and also in the documents (manpages)

_NT_DEBUGGER_EXTENSION_PATH
ALACRITTY_LOG
ANSICON
CC
COLORTERM
COLUMNS
DEBUGINFOD_URLS
EDITOR
LD_LIBRARY_PATH
LIBRARY_PATH
PATH
RZ_ARCH
RZ_ASM_ARCH
RZ_ASM_BITS
RZ_BIN_CODESIGN_VERBOSE
RZ_BIN_DEBASE64
RZ_BIN_DEBUGINFOD_URLS
RZ_BIN_DEMANGLE
RZ_BIN_LANG
RZ_BIN_MAXSTRBUF
RZ_BIN_PDBSERVER
RZ_BIN_PREFIX
RZ_BIN_STRFILTER
RZ_BIN_STRPURGE
RZ_BIN_SYMSTORE
RZ_BITS
RZ_CONFIG
RZ_CURL
RZ_DEBUG_ASSERT
RZ_DEBUG_TOOL
RZ_DYLDCACHE_FILTER
RZ_HTTP_AUTHFILE
RZ_LOGCOLORS
RZ_LOGFILE
RZ_LOGLEVEL
RZ_LOGSHOWSOURCES
RZ_LOGTRAPLEVEL
RZ_NOPLUGINS
RZ_PIPE_IN
RZ_PIPE_OUT
RZ_PREFIX
RZ_RCFILE
SFLIBPATH
SHELL
TEMP
TERM
TMPDIR
WT_SESSION
@wargio wargio added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers labels Apr 18, 2024
@Abhinavcode13
Copy link

These environment variables described above have to be added in different suitable directories and a documentation for them? @wargio

@wargio
Copy link
Member Author

wargio commented Apr 24, 2024

these should for sure be mapped in the man pages, but also in the book. also some are already mapped, but not all of them.
i think they at least should appear in rizin -hh, @XVilka @ret2libc @thestr4ng3r @Rot127 what do you think?

@Rot127
Copy link
Member

Rot127 commented Apr 24, 2024

Agree with it. Definitely in the man pages, book, -hh and -H.

@wargio
Copy link
Member Author

wargio commented Apr 24, 2024

i don't think for -H is needed tho

@Abhinavcode13
Copy link

https://github.com/rizinorg/book this is the repository for book right? @wargio

@wargio
Copy link
Member Author

wargio commented Apr 24, 2024

yes

@Abhinavcode13
Copy link

What about man pages?

@wargio
Copy link
Member Author

wargio commented Apr 25, 2024

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants