fatalerrors/profile
1
0
Fork 0
Code Issues Pull Requests Projects Releases 10 Wiki Activity

update doc

Browse Source
This commit is contained in:
fatalerrors
2026-04-23 17:36:25 +02:00
parent 67bdd3e863
commit e567957ea0
2 changed files with 27 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -58,8 +58,16 @@ A bar-style prompt showing current time, execution time of the last command
| `findbig` | filefct | Find the biggest files in the given or current directory | | `findbig` | filefct | Find the biggest files in the given or current directory |
| `finddead` | filefct | Find dead symbolic links in the given or current directory | | `finddead` | filefct | Find dead symbolic links in the given or current directory |
| `findzero` | filefct | Find empty files in the given or current directory | | `findzero` | filefct | Find empty files in the given or current directory |
| `gacp` | git | Add, commit and push changes; auto-pulls with rebase first if needed |
| `genpwd` | pwd | Generate one or more random secure passwords with configurable constraints | | `genpwd` | pwd | Generate one or more random secure passwords with configurable constraints |
| `ggraph` | git | Display a decorated git history graph |
| `gpid` | processes | Give the list of PIDs matching the given process name(s) | | `gpid` | processes | Give the list of PIDs matching the given process name(s) |
| `gprune` | git | Delete local branches already merged into the main branch |
| `greset` | git | Reset the current branch to upstream, stashing local changes first |
| `groot` | git | Display the repository root path, or change directory to it with `-g` |
| `gsync` | git | Fetch and rebase the current branch onto its upstream |
| `gst` | git | Display compact git status with branch tracking information |
| `gwip` | git | Create a quick WIP checkpoint commit |
| `help` | help | Display the list of available functions and basic usage | | `help` | help | Display the list of available functions and basic usage |
| `isipv4` | net | Tell if the given parameter is a valid IPv4 address | | `isipv4` | net | Tell if the given parameter is a valid IPv4 address |
| `isipv6` | net | Tell if the given parameter is a valid IPv6 address | | `isipv6` | net | Tell if the given parameter is a valid IPv6 address |
@@ -171,6 +179,14 @@ change the default without having to pass flags every time.
| `BUSY_DEFAULT_PATTERN` | `[0-9a-f]` | Hex pattern matched by `busy` | | `BUSY_DEFAULT_PATTERN` | `[0-9a-f]` | Hex pattern matched by `busy` |
| `BUSY_DEFAULT_DELAY` | `0.1` | Polling delay (seconds) for `busy` | | `BUSY_DEFAULT_DELAY` | `0.1` | Polling delay (seconds) for `busy` |
**`[git]`**
| Key | Default | Description |
|---|---|---|
| `GIT_MAIN_BRANCH` | `main` | Fallback main branch name used when remote HEAD cannot be detected |
| `GIT_DEFAULT_REMOTE` | `origin` | Default remote used by git helper functions |
| `GIT_WIP_PREFIX` | `wip` | Prefix used by `gwip` when generating automatic checkpoint messages |
**`[info]`** **`[info]`**
| Key | Default | Description | | Key | Default | Description |

11
doc/profile.conf.example
View File

@@ -76,6 +76,17 @@ TERM=xterm-256color
# busy: Delay between matched lines in milliseconds (0 = no delay). # busy: Delay between matched lines in milliseconds (0 = no delay).
#BUSY_DEFAULT_DELAY=0 #BUSY_DEFAULT_DELAY=0
# ==============================================================================
[git]
# Fallback main branch name used when remote HEAD cannot be detected.
#GIT_MAIN_BRANCH=main
# Default remote used by git helper functions.
#GIT_DEFAULT_REMOTE=origin
# Prefix used by gwip when generating automatic checkpoint messages.
#GIT_WIP_PREFIX=wip
# ============================================================================== # ==============================================================================
[info] [info]
# meteo: Default city when no argument is given. Leave unset to require an # meteo: Default city when no argument is given. Leave unset to require an