Jak zvýraznit příkaz za promptem v bashi (UPDATE)

5.6.2014 08:36 | Přečteno: 2648× | Tipy | | poslední úprava: 22.6.2014 14:28

V minulosti jsem psal článek o barvičkách v terminálu a o tom jak si nastavit vzhled promptu v Bashi. Tohle je tip, který s tím úzce souvisí – jak udělat, aby příkaz za promptem měl jinou barvu, než je výchozí barva textu v terminálu (aniž by to ovlivnilo výstup spouštěného příkazu).

UPDATE: S odstupen času jsem bohužel našel vedlejší efekt, kvůli kterému je to prakticky nepoužitelné. Článek tu nechám, ale nedoporučuji to nastavovat. V posledním odstavci vysvětluji o co jde.

Ten dodatek v závorce je klíčový, protože k té první části se dovtípí asi každý, už jen proto, že při počátečním experimentováním s barvami se to člověku může přihodit nechtěně – stačí, když se nenastaví výchozí neutrální barva pomocí speciální escape sekvence a další příkaz, který napíšete, včetně jeho výstupu (pokud sám nenastavuje barvy) má poslední nastavenou barvu / styl.

Pokud nevíte o čem mluvím, zkuste si v bashi spustit tohle:

unset PROMPT_COMMAND
export PS1="\[\e[0m\]$PS1\[\e[36;1m\]"

a potom napište a spusťte třeba:

echo Test

Pokud nemáte nějaký speciálně nastavený terminál, tak byste měli vidět příkaz i jeho výstup zbarvený do tyrkysova.

Jenže záhada pro mě byla jiná věc – jak to udělat, aby se barva hned po potvrzení příkazu změnila na původní?

Našel jsem na to poměrně elegantní trik na superuser.com. Ano, je to oblezlička, ale funguje mi docela spolehlivě. Je potřeba nastavit, aby bash odchytával a reagoval na signál DEBUG, který sám vysílá při každém odenterování příkazu. A reagovat bude samozřejmě tím, že nastaví zase barvu na výchozí.

trap 'echo -ne "\e[0m"' DEBUG

TL;DR

Přidejte si do ~/.bashrc tohle:

trap 'echo -ne "\e[0m"' DEBUG

a podle toho, zda si nastavujete PS1 sami dynamicky pomocí PROMPT_COMMAND, anebo používáte statický prompt, tak si upravte nastavení proměnné PS1. Pokud nevíte, co jsem to právě napsal, tak zkuste pod ten trap do ~/.bashrc přidat ještě řádek:

export PS1="\[\e[0m\]$PS1\[$(tput bold)\]"

Spuštěním nové instance bashe ověřte, zda to funguje správně. Měl by být obarvený (resp. v tomto případě tučný) pouze příkaz, který zadáváte a ne jeho výstup.

Motivace

Když máte barevný prompt, tak není problém najít v jednolitém výstupu místo, kde to celé začíná, tak proč se obtěžovat s obarvováním příkazu? Když často spouštíte dlouhé a komplikované příkazy, tak vyvstane nový problém – i když najdete začátek příkazu, tak je někdy obtížné najít jeho konec, protože ten může splývat s výstupem příkazu. Když si příkaz obarvíte či zvýrazníte, odlišíte jej pak na první pohled.

P.S.

Přečtěte si i diskuzi, jsou tam další tipy. Např. je potřeba upravit i PS2 (tj. prompt druhé a další řádky příkazu, který se vypíše např. když odenterujete příkaz končící znakem \ anebo když neuzavřete text apostrofech/uvozovkách), nemá-li být její text zvýrazněný.

export PS2="\[\e[0m\]$PS2\[$(tput bold)\]"

A ještě jeden poznatek: tput sice zjednodušuje vkládání některých sekvencí, ale nepoužívejte ho v PROMPT_COMMANDu (resp. v souboru, který sourcuje), protože by to zbytečně forkovalo při každým zobrazení promptu.

UPDATE - nenastavujte si to

Bohužel jsem našel jeden hodně nepříjemnej vedlejší efekt, když jsem si nějakým cyklem v bashi generoval výstup, který jsem pak přesměroval do souboru. V tomto souboru se pak objevila část barevné escape sekvence, která tam samozřejmě neměla co dělat. Takže to není tak skvělé, jak jsem si na začátku myslel.

       

Obrázky

Komentáře

[xkucf03]

Pěkný hack, ale má to jednu drobnou vadu – když mačkám enter, aniž bych psal nějaký příkaz, mám tučně i prompt (nevyšle se DEBUG signál, který by nastavil písmo na normální).

[David Watzke]

Tak tohle u sebe nepozoruju, ale mělo by to jít snadno obejít resetováním barvy na začátku PS1.

[xkucf03]

Snadná oprava:

export PS1="\e[0m$PS1\[$(tput bold)\]"
trap 'echo -ne "\e[0m"' DEBUG

[xkucf03]

A ještě jeden problém: BASH completion (všechno tučně).

[David Watzke]

Jo, to je pravda, i normální doplňování názvů souborů to dělá. No, je to vedlejší efekt, se kterým asi nepůjde nic moc dělat, protože znaky psaný do bashe žere readline a tu asi nepřesvědčíš, aby vygenerovala DEBUG signál pro bash (a i kdyby, kdoví jestli by to nezpůsobilo další vedlejší efekty).

[kralyk z abclinuxu]

Pěknej trik, debug jsem dřív používal na hrubý zobrazení doby trvání posledního příkazu, ale tohle je lepší využití...

Pár poznatků: 1) nedoporučuju v PS1 používat $(), protože forkuje při každým zobrazení PS1, 2) PS2 je bold, ale ne že by to vadilo, dá se to samozřejmě pořešit...

[xkucf03]

Vylepšená verze:

export PS1="\e[0m$PS1\e[1m"
export PS2="\e[0m$PS2\e[1m"
trap 'echo -ne "\e[0m"' DEBUG

[David Watzke]

Díky za připomínky!

ad 1) to není pravda, pokud nastavuješ PS1 v .bashrc, protože tam se to expanduje a už se na to nesahá, ale je to pravda pokud jej nastavuješ přes PROMPT_COMMAND, ten se spouští pokaždé - zrovna tak je dobré se tomu vyhnout v tom trap, protože tam je příkaz v apostrofech, a tak se proměnná neexpanduje hned.

[kralyk z abclinuxu]

Aha sorry já si nevšim, že tam máš uvozovky, ne apostrofy, tak to jo... Jinak PROMPT_COMMAND se evaluuje (to je krásný češtin ) v původním procesu, takže pokud tam člověk nenacpe $(), tak by forkovat neměl...

[Bystroushaak]

Příloha:

• Snímek obrazovky-Terminal.png (9285 bytů)

Já jsem teď řešil zvýraznění return code a zároveň zkracování dlouhých cest. Nakonec jsem to poskládal z netu:

GREEN="\e[1;32m"
RED="\e[1;31m"
WHITE="\e[m"
EXIT_COLOR(){
    printf -- "$(_dir_chomp "$(pwd)" 40),"
    [[ 0 == "$1" ]] && printf -- "$GREEN$1" || printf -- "$RED$1";
    printf -- "$WHITE$"
}

_dir_chomp () {
    local IFS=/ c=1 n d
    local p=(${1/#$HOME/\~}) r=${p[*]}
    local s=${#r}
    while ((s>$2&&c<${#p[*]}-1))
    do
        d=${p[c]}
        n=1;[[ $d = .* ]]&&n=2
        ((s-=${#d}-n))
        p[c++]=${d:0:n}
    done
    printf -- "${p[*]}"
}
PS1='\u:$(EXIT_COLOR $?) '

[David Watzke]

Dva subshelly a jedno externí volání. $(pwd) by mělo jít zefektivnit na $PWD.

[kralyk z abclinuxu]

Tohle je lepší řešit v PROMPT_COMMAND, kde se vyhneš těm subshellům. Mam to takhle:

_ret_ok=$(echo -e '\e[0;32m✔\e[0m')
_ret_bad=$(echo -e '\e[0;31m✖\e[0m')

PROMPT_COMMAND='[ $? -eq 0 ] && _ret="$_ret_ok" || _ret="$_ret_bad$?";'
PS1=' ${_ret} \D{%H:%M} \e[0;32m\u\e[0m \w \$ \e[1m'
PS2='\e[0m> \e[1m'

Screenshot.

[xkucf03]

Pěkné Do _ret_ok bych ještě přidal mezeru, aby to bylo zarovnané. A chybí mi tam název stroje.

[David Watzke]

Mezera zarovnání neřeší, protože retval může být tříznaková. Řešil by to printf "%3d" $exitcode nebo něco takovýho.

[David Watzke]

Vždyť tam máš dva subshelly hned na začátku

[kralyk z abclinuxu]

Ty by se měly províst jen při zpracování .bashrc, pak už ne... Šlo by to i bez nich, když se tam ten escape nacpe rovnou, což je trochu prasárna a ábíčko mi to nebere, takže to sem nevložim Nebo to jde líp?

[David Watzke]

_ret_ok=$'\e[0;32m✔\e[0m'
_ret_bad=$'\e[0;31m✖\e[0m'

[kralyk z abclinuxu]

ahá, pěkný, dík

[Bystroushaak]

Trochu jsem to zrefactoroval, co tohle:

GREEN="\e[1;32m"
RED="\e[1;31m"
WHITE="\e[m"
DIR_CHOMP(){
    local IFS=/ c=1 n d
    local p=(${1/#$HOME/\~}) r=${p[*]}
    local s=${#r}
    while ((s>$2&&c<${#p[*]}-1))
    do
        d=${p[c]}
        n=1;[[ $d = .* ]]&&n=2
        ((s-=${#d}-n))
        p[c++]=${d:0:n}
    done
    printf -- "${p[*]}"
}

EXIT_COLOR(){
    DIR_CHOMP "$PWD" 40
    printf -- ","
    [[ 0 == "$1" ]] && printf -- "$GREEN$1" || printf -- "$RED$1";
    printf -- "$WHITE$"
}
PS1='\u:`EXIT_COLOR $?` '

Zdá se mi to subjektivně rychlejší.

[xkucf03]

Proč funkce EXIT_COLOR() řeší adresáře? Minimálně bych ji přejmenoval na něco výstižnějšího, když už to má být takhle v jedné funkci.

[Bystroushaak]

Proč funkce EXIT_COLOR() řeší adresáře? Minimálně bych ji přejmenoval na něco výstižnějšího, když už to má být takhle v jedné funkci.

Funkce EXIT_COLOR() neřeší adresáře, řeší výpis $? + barvy. To volání adresářové funkce je nutné z EXIT_COLOR(), protože kdyby došlo k volání DIR_CHOMP() dříve, tak už by se nedostala k return value. Šla by tam přidat ještě třetí funkce, která to všechno poskládá dohromady, ale to už se mi zdá zbytečné.

Jinak to chce místo

PS1='\u:`EXIT_COLOR $?` '

použít

PS1='\u:\[`EXIT_COLOR $?`\] '

jinak to silně blbne na konci řádku.

[xkucf03]

To volání adresářové funkce je nutné z EXIT_COLOR(), protože kdyby došlo k volání DIR_CHOMP() dříve, tak už by se nedostala k return value.

Však ona ta struktura může zůstat stejná, jen bych to prostě přejmenoval – když si čtu PS1 a vidím tam nějaký EXIT_COLOR $?, tak čekám, že to asi vypíše obarvený kód – a ejhle, ono to dělá ještě něco jiného. Tady na tom až tolik nesejde, protože je to kód na pár řádků resp. člověk to vidí hned nad tím, co to dělá, ale stejně…

[David Watzke]

Nestačilo by to volání DIR_CHOMP dát prostě pod definici funkce EXIT_COLOR (a nad PS1, který ji volá)?

[David Watzke]

To s tím \[blabla\] platí pro všechny barvy, i ty co máš definovaný výše, dělá to jinak nepředvídatelnej bordel (např. se nemůžeš vrátit kurzorem na začátek příkazu vytaženýho z historie a podobný prasečiny).

[Bystroushaak]

Funguje mi to jen v PS1. Všude jinde se to vloží tak jak jsem to uvedl.

Co to vůbec má být tohleto?

[David Watzke]

No, jsou to jen řídící sekvence, ale bash/readline je započítává jako znaky, takže když se ti pak má vrátit kurzor zpátky, tak je z toho nablblej - má špatný souřadnice. Tím \[ a \] mu řekneš, že to mezi tím nemá počítat.

[xkucf03]

On by ale neměl počítat jen ty řídící sekvence, jiné znaky (text) ano.

Jak by mělo správně vypadat tohle?

export PS1="\e[0m$PS1\e[1m"
export PS2="\e[0m$PS2\e[1m"
trap 'echo -ne "\e[0m"' DEBUG

(to mi právě rozbilo editaci příkazů vytažených z historie)

[Bystroushaak]

Příloha:

• znaky.png (1101 bytů)

Já jsem to teď vyřešil poměrně prasácky, ale funkčně. Ty hranaté závorky nepomůžou se vším, resp. ne když se do toho volá funkce. Pomohlo mi tohle: http://superuser.com/questions/367275/linux-coloring-bash-prompt-will-break-carriage-return

GREEN="?\e[1;32m?"
RED="?\e[1;31m?"
WHITE="?\e[0m?"
DIR_CHOMP(){
    local IFS=/ c=1 n d
    local p=(${1/#$HOME/\~}) r=${p[*]}
    local s=${#r}
    while ((s>$2&&c<${#p[*]}-1))
    do
        d=${p[c]}
        n=1;[[ $d = .* ]]&&n=2
        ((s-=${#d}-n))
        p[c++]=${d:0:n}
    done
    echo -ne "${p[*]}"
}

EXIT_COLOR(){
    DIR_CHOMP "$PWD" 40
    echo -n ","
    [[ $1 == 0 ]] && echo -ne "$GREEN$1" || echo -ne "$RED$1";
    echo -ne "$WHITE"
}

COMMAND_PROMPT=
PS1='\u:`EXIT_COLOR $?`\$ '

Podstatná je změněná definice

GREEN="?\e[1;32m?"
RED="?\e[1;31m?"
WHITE="?\e[0m?"

To sice může vypadá stejně, ale hned za/před uvozovkama jsou vložené znaky s ASCII kódem 1 a 2, které dělají to samé co \[ resp. \], které se ale nedají vložit do toho volání funkce (zkoušel jsem všechno možné, nedají - vypadá to, že PS1 unescapuje ty znaky ještě před tím, než zavolá tu funkci, takže tam potom už nejsou).

Pokud se nepodaří HTML přenos, tak si je můžete vyrobit v interaktivním pythonu stylem:

>>> print ">%s<" % chr(1)
>?<
>>> print ">%s<" % chr(2)
>?<

Zkopírovat a potom ručně odmazat > a <.

[David Watzke]

Tohle je nesmysl, použij prostě to co jsem psal kralykovi v #17

[Bystroushaak]

To co jsi psal kralykovi v mém případě nefunguje (zkus to).

[kralyk z abclinuxu]

Pokud ti vadí dlouhá cesta, možná bys měl nejjednodušší si napsat dvouřádkový PS1...

[Bystroushaak]

Já jsem ve věcech rozhraní velmi konzervativní a dvouřádkové PS1 by mi vadilo podstatně víc, než dlouhá cesta.

[David Watzke]

Ok, věřím. Teď jsem si teprv všiml, že používáš subshell v PS1, to je teda pěkný zlo.

Já osobně používám tohle:

v ~/.bashrc:

export PROMPT_COMMAND='. ~/.prompt'

v ~/.prompt:

#!/bin/bash

S=$?

END="\[\e[0m\]"
RED="\[\e[31;1m\]"
CYAN="\[\e[36;1m\]"
GREEN="\[\e[32;1m\]"
YELLOW="\[\e[33;1m\]"

if [[ $S -eq 0 ]]; then
        DOLLAR="${YELLOW}\$"
else
        DOLLAR="${RED}\$"
fi

PS1="${CYAN}\u${END}@${RED}\h${END} ${GREEN}\w${END} ${DOLLAR}${END} "

Vyhneš se subshellům a problémům s escapováním.

[Šangala]

Jeslti jsme se neupsal tak asi takto:

export PS1="\[\e[0m\]$PS1\[\e[1m\]"
export PS2="\[\e[0m\]$PS2\[\e[1m\]"

mezi \[ \] a včetně se nezeapočítívá, takže pokud to nemá šířku, musí se to mezi to zavřít…

[David Watzke]

Přesně tak, opravil jsem to v zápisku. Mimochodem, do echa v tom trapu to nepatří, jenom do promptu.

[xkucf03]

Dík, tohle už funguje pěkně.

[xkucf03]

Tak jsem narazil ještě na jeden problém:

$ echo ahoj
ahoj

$ (echo ahoj)
ahoj

$ (echo ahoj);
ahoj

$ time (date); echo ahoj
So čen  7 21:26:45 CEST 2014

real    0m0.003s
user    0m0.000s
sys     0m0.003s
ahoj

Výpisy po závorkách jsou tučně, i když by neměly.

[kralyk z abclinuxu]

A já si říkal, proč mi to blbne Dík.

Mimochodem, ten, kdo vymejšlel escape sekvence, musel imho jet na nějakejch drogách (typuju nějaký amfetaminy), jsou totálně ulítlý.

Například nasledující sekvence přesune kurzor o 3 znaky doprava: \e[3C. Teď záludná otázka: O kolik přesune znak sekvence \e[0C? Správně tušíte, že nula není správná odpověď, protože 0 = "chci default" a pro sekvenci CSI C je default 1, takže to přesune znak o 1 doprava. Aby to bylo zábavnější, různé sekvence mají různé defaulty, někdy 0, někdy 1, myslimže nějaká sekvence má dokonce default 100.

Je ovšem možné vymyslet i mnohem zábavnější sekvence, např. tohle:

echo -e '\e7\e[2\e[?2l\eH\eC\e<\e[2K\e[7m\e+0\eo`\en HAHA \eo`\e8'

Jen tak vod voka říct, co tohle dělá, není úplně jednoduchý. Ale vyzkoušejte, nedělá nic špatnýho...

[David Watzke]

Hmm, to je slušný psycho

[kralyk z abclinuxu]

Aha, tak beru zpět to "nedělá nic špatnýho", některý emulátory terminálu nepodporují správně \e8 (GTK VTE-based terminály)