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.

Sign up for GitHub

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

Update references to the rizinrc config file #103

Closed
wants to merge 2 commits into from
Closed

Update references to the rizinrc config file #103

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ffa17a3
Update references of .rizinrc
nullun Sep 26, 2023
0f7d5c8
Show latest output
nullun Sep 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/configuration/colors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Console access is wrapped in API that permits to show the output of any command

To enable colors support by default, add a corresponding configuration option to the .rizin configuration file:
```
$ echo 'e scr.color=1' >> ~/.rizinrc
$ echo 'e scr.color=1' >> ~/.config/rizin/rizinrc
```
Note that enabling colors is not a boolean option. Instead, it is a number because there are different color depth levels. This is:

Expand Down
2 changes: 1 addition & 1 deletion src/configuration/evars.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -348,7 +348,7 @@ Rizin also supports custom fortunes. You can save your fortunes in a file and pr
[0x00000000]> e cfg.fortunes.file=/path/to/my/fortunes.txt
```

Please make sure that you add these in your `~/.rizinrc` to preserve the changes when you reopen rizin.
Please make sure that you add these in your `~/.config/rizin/rizinrc` to preserve the changes when you reopen rizin.

### cfg.newtab: `bool`

Expand Down
14 changes: 6 additions & 8 deletions src/configuration/intro.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ To prevent rizin from parsing this file at startup, pass it the `-N` option.

All the configuration of rizin is done with the `eval` commands. A typical startup configuration file looks like this:
```sh
$ cat ~/.rizinrc
$ cat ~/.config/rizin/rizinrc
e scr.color=1
e dbg.bep = loader
```
The configuration can also be changed with `-e` <config=value> command-line option. This way you can adjust configuration from the command line, keeping the .rizinrc file intact. For example, to start with empty configuration and then adjust `scr.color` and `asm.syntax` the following line may be used:
The configuration can also be changed with `-e` <config=value> command-line option. This way you can adjust configuration from the command line, keeping the `~/.config/rizin/rizinrc` file intact. For example, to start with empty configuration and then adjust `scr.color` and `asm.syntax` the following line may be used:
```sh
$ rizin -N -e scr.color=1 -e asm.syntax=intel -d /bin/ls
```
Expand All @@ -27,14 +27,12 @@ Usage: e[?] # List/get/set config evaluable vars
| e <key>[=<val|?>] [<key>[=<val|?>] ...]] # Get/Set value of config variable <key>
| el[j*qlJ] [<key>] # List config variables with their descriptions
| e- # Reset config variables
| e! <key> # Invert the boolean value of config variable <var>
| e! <key> # Invert the boolean value of config variable <key>
| ec[?] # Set color for given key (prompt, offset, ...)
| ee <key> # Open editor to change the value of config variable <var>
| ed # Open editor to change ~/.rizinrc
| er <key> # Set config variable <var> as read-only
| ee <key> # Open editor to change the value of config variable <key>
| er <key> # Set config variable <key> as read-only
| es [<key>] # List all config variable spaces or sub-keys/sub-spaces if a <key> is provided
| et <key> # Show type of given config variable <var>
| env [<varname>[=<varvalue>]] # Get/set environment variables
| et <key> # Show type of given config variable <key>
```

A simpler alternative to the `e` command is accessible from the visual mode. Type `Ve` to enter it, use arrows (up, down, left, right) to navigate the configuration, and `q` to exit it. The start screen for the visual configuration edit looks like this:
Expand Down