heckyel/hyperterm
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update README.md

Browse Source
This commit is contained in:
Astound 2025-01-04 11:36:28 +08:00
parent 59faa96386
commit d3822dbd8b
Signed by: kaiser
GPG Key ID: 97504AF0027B1A56
2 changed files with 65 additions and 73 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

87
README.md
View File

@ -11,6 +11,7 @@ Custom Prompt Shell Settings for Bash
- coreutils - coreutils
## Features ## Features
- Show Git information (branch, tag, or where you did `git checkout`) - Show Git information (branch, tag, or where you did `git checkout`)
- It allows knowing the status (*exit status*) of the Prompt Shell after executing one/some command(s). - It allows knowing the status (*exit status*) of the Prompt Shell after executing one/some command(s).
- Makes source to `/usr/share/doc/pkgfile/command-not-found.bash` automatically (requires `pkgfile`). - Makes source to `/usr/share/doc/pkgfile/command-not-found.bash` automatically (requires `pkgfile`).
@ -21,60 +22,58 @@ Custom Prompt Shell Settings for Bash
>Your changes must be in `$HOME/.hyperterm/_custom.sh`, so that are not deleted when it is updated. >Your changes must be in `$HOME/.hyperterm/_custom.sh`, so that are not deleted when it is updated.
- Special functions like: - Special functions like:
- `activate` to activate virtualenv in python
* `activate` to activate virtualenv in python - `cex` compress files and/or directories
* `cex` compress files and/or directories - `ex` extract files
* `ex` extract files - `ii` general system information
* `ii` general system information - `proxy_on` enables proxy in terminal or tty
* `proxy_on` enables proxy in terminal or tty - `sagent_start` and `sangent_stop` to enable or disable the SSH agent (password is remembered for 432000 seconds)
* `sagent_start` and `sangent_stop` to enable or disable the SSH agent (password is remembered for 432000 seconds) - `rar2zip` convert RAR files to ZIP, use `unar` and `7z`
* `rar2zip` convert RAR files to ZIP, use `unar` and `7z`
- Aliases like: - Aliases like:
- `clean` clears the bash history
* `clean` clears the bash history - `df` shows information about the partitions of the S.O.
* `df` shows information about the partitions of the S.O. - `pastebin` allows you to quickly generate a paste for example: `cat/etc/*release | pastebin` or `sensors | pastebin`
* `pastebin` allows you to quickly generate a paste for example: `cat/etc/*release | pastebin` or `sensors | pastebin` - `ep` open a PKGBUILD with emacs
* `ep` open a PKGBUILD with emacs - `free` shows RAM and SWAP information
* `free` shows RAM and SWAP information - `grep` skips its colors by default
* `grep` skips its colors by default - `la` short of `ls -la --group-directories-first --time-style=+"%d.%m.%Y %H:%M" --color=auto -F`
* `la` short of `ls -la --group-directories-first --time-style=+"%d.%m.%Y %H:%M" --color=auto -F` - `ll` short of `ls -l --group-directories-first --time-style=+"%d.%m.%Y %H:%M" --color=auto -F`
* `ll` short of `ls -l --group-directories-first --time-style=+"%d.%m.%Y %H:%M" --color=auto -F` - `ls` short of `ls --group-directories-first --time-style=+"%d.%m.%Y %H:%M" --color=auto -F`
* `ls` short of `ls --group-directories-first --time-style=+"%d.%m.%Y %H:%M" --color=auto -F` - `np` open a PKGBUILD with nano
* `np` open a PKGBUILD with nano
- Look at [tools](hyperterm/tools) directory for more functions. - Look at [tools](hyperterm/tools) directory for more functions.
- Run `screenfetch` if installed (included in the `hyperterm/_custom.sh` template). - Run `screenfetch` if installed (included in the `hyperterm/_custom.sh` template).
## Installation ## Installation
### Semi-automatic ### Semi-automatic Installation
1. Download file `install.sh`: 1. Download file `install.sh`:
$ curl -Ls https://git.fridu.us/heckyel/hyperterm/raw/branch/master/install.sh -o "$HOME/install.sh" curl -Ls https://git.fridu.us/heckyel/hyperterm/raw/branch/master/install.sh -o "$HOME/install.sh"
2. Run file `install.sh` 2. Run file `install.sh`
$ bash "$HOME/install.sh" bash "$HOME/install.sh"
or in silent mode: or in silent mode:
$ bash "$HOME/install.sh" -s bash "$HOME/install.sh" -s
use -h to show help: use -h to show help:
$ bash "$HOME/install.sh" -h bash "$HOME/install.sh" -h
3. Delete file `install.sh`: 3. Delete file `install.sh`:
$ rm -v "$HOME/install.sh" rm -v "$HOME/install.sh"
### Manual ### Manual Installation
1. As a suggestion, make a backup of your Prompt Shell. 1. As a suggestion, make a backup of your Prompt Shell.
$ for f in .bashrc .bash_aliases .bash_profile; do cp -v "$HOME/$f" "$HOME/$f.bak"; done for f in .bashrc .bash_aliases .bash_profile; do cp -v "$HOME/$f" "$HOME/$f.bak"; done
2. Clone the HyperTerm repository: 2. Clone the HyperTerm repository:
@ -83,37 +82,37 @@ Custom Prompt Shell Settings for Bash
3. Copy the HyperTerm files to your Local Directory 3. Copy the HyperTerm files to your Local Directory
$ install -d -m755 "$HOME/.hyperterm" install -d -m755 "$HOME/.hyperterm"
$ cp -rv $HOME/bash/hyperterm/* "$HOME/.hyperterm" cp -rv $HOME/bash/hyperterm/* "$HOME/.hyperterm"
$ cp -v $HOME/bash/.bash* "$HOME" cp -v $HOME/bash/.bash* "$HOME"
$ cp -v $HOME/bash/hyperterm/_custom.sh "$HOME/.hyperterm" cp -v $HOME/bash/hyperterm/_custom.sh "$HOME/.hyperterm"
$ install -m644 $HOME/bash/template/bash_profile.template.bash "$HOME/.bashrc" install -m644 $HOME/bash/template/bash_profile.template.bash "$HOME/.bashrc"
4. Open your terminal again or execute the next instruction 4. Open your terminal again or execute the next instruction
$ . $HOME/.bashrc* . $HOME/.bashrc*
5. Delete the repository if you are not interested in having it stored 5. Delete the repository if you are not interested in having it stored
$ rm -rfv bash rm -rfv bash
6. Done! 6. Done!
## Post-installation ## Post-installation
* Optionally you can install trash-cli, pkgfile, bind-tools, bash-completion - Optionally you can install trash-cli, pkgfile, bind-tools, bash-completion
$ pacman -S trash-cli pacman -S trash-cli
$ pacman -S pkgfile pacman -S pkgfile
$ pacman -S bind-tools pacman -S bind-tools
$ pacman -S bash-completion pacman -S bash-completion
>[!TIP] >[!TIP]
> [trash-cli](https://github.com/andreafrancia/trash-cli): is a utility to prevent accidental deletion when using the rm -rf command > [trash-cli](https://github.com/andreafrancia/trash-cli): is a utility to prevent accidental deletion when using the rm -rf command
@ -178,25 +177,25 @@ Custom Prompt Shell Settings for Bash
1. Download file `uninstall.sh`: 1. Download file `uninstall.sh`:
$ curl -Ls https://git.fridu.us/heckyel/hyperterm/raw/branch/master/uninstall.sh -o "$HOME/uninstall.sh" curl -Ls https://git.fridu.us/heckyel/hyperterm/raw/branch/master/uninstall.sh -o "$HOME/uninstall.sh"
2. Run file `uninstall.sh`: 2. Run file `uninstall.sh`:
$ bash "$HOME/uninstall.sh" bash "$HOME/uninstall.sh"
3. Delete file `uninstall.sh`: 3. Delete file `uninstall.sh`:
$ rm -v "$HOME/uninstall.sh" rm -v "$HOME/uninstall.sh"
### Manual ### Manual
If you want to leave your computer as it was, delete the files copied from step 3 with: If you want to leave your computer as it was, delete the files copied from step 3 with:
$ rm -vrf "$HOME/{.hyperterm/,.bashrc}" rm -vrf "$HOME/{.hyperterm/,.bashrc}"
and restore the ***.bak** files from step 1 by running: and restore the ***.bak** files from step 1 by running:
$ for f in .bashrc .bash_aliases .bash_profile; do cp -v "$HOME/$f.bak" "$HOME/$f"; done for f in .bashrc .bash_aliases .bash_profile; do cp -v "$HOME/$f.bak" "$HOME/$f"; done
## Hacking ## Hacking

51
README_es.md
View File

@ -9,6 +9,7 @@ Configuración personalizada del Prompt Shell para Bash
- git - git
## Características ## Características
- Muestra información de Git (rama, tag, o donde hiciste `git checkout`) - Muestra información de Git (rama, tag, o donde hiciste `git checkout`)
- Permite saber el estado (*exit status*) del Prompt Shell después de ejecutar un/unos comando(s). - Permite saber el estado (*exit status*) del Prompt Shell después de ejecutar un/unos comando(s).
- Hace source a `/usr/share/doc/pkgfile/command-not-found.bash` automaticamente (requiere de `pkgfile`). - Hace source a `/usr/share/doc/pkgfile/command-not-found.bash` automaticamente (requiere de `pkgfile`).
@ -19,27 +20,25 @@ Configuración personalizada del Prompt Shell para Bash
>Tus cambios deben estar en `$HOME/.hyperterm/_custom.sh`, para que no se eliminen al momento de actualizarlo. >Tus cambios deben estar en `$HOME/.hyperterm/_custom.sh`, para que no se eliminen al momento de actualizarlo.
- Funciones especiales como: - Funciones especiales como:
- `activate` para activar virtualenv en python
* `activate` para activar virtualenv en python - `cex` comprimir archivos y/o directorios
* `cex` comprimir archivos y/o directorios - `ex` extraer archivos
* `ex` extraer archivos - `ii` información general del sistema
* `ii` información general del sistema - `proxy_on` activa proxy en el terminal o tty
* `proxy_on` activa proxy en el terminal o tty - `sagent_start` y `sangent_stop` para activar o desactivar el agente SSH (la contraseña es recordada por 432000 segundos)
* `sagent_start` y `sangent_stop` para activar o desactivar el agente SSH (la contraseña es recordada por 432000 segundos) - `rar2zip` convierte archivos RAR a ZIP, utiliza `unar` y `7z`
* `rar2zip` convierte archivos RAR a ZIP, utiliza `unar` y `7z`
- Aliases como: - Aliases como:
- `clean` limpia el historial de bash
* `clean` limpia el historial de bash - `df` muestra información de las particiones del S.O.
* `df` muestra información de las particiones del S.O. - `pastebin` permite generar rápidamente un paste por ejemplo: `cat /etc/*release | pastebin` o `sensors | pastebin`
* `pastebin` permite generar rápidamente un paste por ejemplo: `cat /etc/*release | pastebin` o `sensors | pastebin` - `ep` abre un PKGBUILD con emacs
* `ep` abre un PKGBUILD con emacs - `free` muestra información de la RAM y SWAP
* `free` muestra información de la RAM y SWAP - `grep` salta los colores del mismo por defecto
* `grep` salta los colores del mismo por defecto - `la` abreviación de `ls -la --group-directories-first --time-style=+"%d.%m.%Y %H:%M" --color=auto -F`
* `la` abreviación de `ls -la --group-directories-first --time-style=+"%d.%m.%Y %H:%M" --color=auto -F` - `ll` abreviación de `ls -l --group-directories-first --time-style=+"%d.%m.%Y %H:%M" --color=auto -F`
* `ll` abreviación de `ls -l --group-directories-first --time-style=+"%d.%m.%Y %H:%M" --color=auto -F` - `ls` abreviación de `ls --group-directories-first --time-style=+"%d.%m.%Y %H:%M" --color=auto -F`
* `ls` abreviación de `ls --group-directories-first --time-style=+"%d.%m.%Y %H:%M" --color=auto -F` - `np` abre un PKGBUILD con nano
* `np` abre un PKGBUILD con nano
- Mirar el directorio [tools](hyperterm/tools) para conocer más funciones. - Mirar el directorio [tools](hyperterm/tools) para conocer más funciones.
- Ejecuta `screenfetch` si está instalado (incluido en la plantilla `hyperterm/_custom.sh`). - Ejecuta `screenfetch` si está instalado (incluido en la plantilla `hyperterm/_custom.sh`).
@ -103,7 +102,7 @@ Configuración personalizada del Prompt Shell para Bash
## Post-instalación ## Post-instalación
* Opcionalmente puede instalar trash-cli, pkgfile, bind-tools, bash-completion - Opcionalmente puede instalar trash-cli, pkgfile, bind-tools, bash-completion
pacman -S trash-cli pacman -S trash-cli
@ -176,21 +175,15 @@ Configuración personalizada del Prompt Shell para Bash
1. Descargar el archivo `uninstall.sh`: 1. Descargar el archivo `uninstall.sh`:
```console curl -Ls https://git.fridu.us/heckyel/hyperterm/raw/branch/master/uninstall.sh -o "$HOME/uninstall.sh"
$ curl -Ls https://git.fridu.us/heckyel/hyperterm/raw/branch/master/uninstall.sh -o "$HOME/uninstall.sh"
```
2. Ejecutar el archivo `uninstall.sh`: 2. Ejecutar el archivo `uninstall.sh`:
```console bash "$HOME/uninstall.sh"
$ bash "$HOME/uninstall.sh"
```
3. Eliminar el archivo `uninstall.sh`: 3. Eliminar el archivo `uninstall.sh`:
```console rm -v "$HOME/uninstall.sh"
$ rm -v "$HOME/uninstall.sh"
```
### Manualmente ### Manualmente