Anonyme, en lecture seule : git clone git://bebou.netlib.re/zenu
Authentifié·e, en écriture : git clone ssh://git@bebou.netlib.re:1459/srv/git/zenu

Log | Files | Refs | README | zip | tar.gz |

README (7666B)

 # A CLI menu engine in ZSH
 
 Written by Marc Chantreux
 
 ## How to install
 
 Zenu requires at least zsh and GNU sed to work. On debian machines they can be
 installed with :
 
 	apt install zsh coreutils
 
 Provide menu files in a `menus` folder found at the root of this git
 project. Create it if it doesn't exist :
 
 	mkdir -p path/to/zenu/menus
 
 Examples given in the `eg` folder can be copied to `menus` :
 
 	cp path/to/zenu/eg/* menus
 
 Build the script files
 
 	make
 
 ### Launch if you use zsh as your login shell
 
 Source the ZSH functions written in zenu.zsh in your `.zshrc` file. If it
 doesn't exist you may create it, preferably in your home. In a typical install
 this would be done with (replace `path/to/zenu/` with the folder in which you
 found this README file`) :
 
 	echo ". path/to/zenu/zenu.zsh" >> $HOME/.zshrc
 
 And launch the loop
 
 	zenu.loop in path/to/zenu/menus
 
 You can make the command `zenu.loop in path/to/zenu/menus` easily accessible
 in you `.zshrc` file :
 
 	# With an alias
 	alias z="zenu.loop in path/to/zenu/menus"
 	# And a shortcut (ctrl+w)
 	bindkey -s '' 'z'
 
 ### Launch if you use another login shell
 
 You may still use zenu if you use another login shell. Launch zsh with a
 command that sources `zenu.zsh` and calls the `zenu.loop` command :
 
 	zsh -c '. ~/git/zenu/zenu.zsh; zenu.loop in ~/git/zenu/menus'
 
 Make sure you create a function or an alias in your shell's `rc` file for
 easier use :)
 
 ## Usage
 
 To enter submenus and/or execute commands, use the highlighted key. By default
 to go back one menu press enter.
 
 ### Creating / Customizing menus
 
 Menus are stored in the `menus` folder. The file named `main` is the default
 starting menu. A menu is defined as
 
 #### A list of commands and/or submenus with one given key being its activator
 
 This part of the main menu given as an example looks like :
 
 	_screens
 	_network
 	_update
 
 by default the character preceding the activator key has to be `_`.
 
   2. An optional "pre" section
 
 This section is arbitrary zsh code executed before zenu listens for a key
 press. It can be used to make the following section easier to write or print
 information below the menu section. By default this section starts after a `##
 pre` comment in our menu declaration.
 
 In the main menu pre section is as follows :
 
 	## pre
 	cat <<%
 	Highlighted key to open menu
 	q to go back
 	= to edit menu
 	%
 
 	zenu_battery=$( upower -i /org/freedesktop/UPower/devices/DisplayDevice | grep -E 'percentage|time')
 	current_time=$(date +"%Hh%M.")
 	zenu_ssid="ssid:$( nmcli | grep "connected to " | sed 's/.*\( .*$\)/\1/' )"
 	echo "${ssid:-not connected}\n$current_time\n$battery"
 	ip -4 -br  addr | tail -n1 | tr -s ' ' | cut -f3 -d" "
 
 
 Which (at least on our debian machines) prints basic information about the machine network interfaces, battery state & time. 
 
   3. A scripting "react" section
 
 This section is where you declare what each command should do. It starts with a
 `## react` command and follows the zsh `case` syntax.
 
 The react section of the main menu in the eg folder :
 
 	## react
 	;; (s) zenu+ screens
 	;; (n) zenu+ network
 	;; (u)
 		sudo apt update && sudo apt upgrade
 		read -k1
 
 The line should always start with `;;`. The letter between brackets should
 match with the corresponding activator key in the first section. In the first
 section the "m" key was identified as activating the `mail` command therefore
 corresponding reaction should be `;; (m) command`.
 
 What comes after the activation key is arbitrary zsh code. If a submenu is to be
 opened the `zenu+` function, written in `zenu.zsh` can be used with the name of
 the submenu passed as an argument. For it to work the given argument has to exist
 as a menu file in `menus`.
 
 The entire main menu file with an added small tutorial would be :
 
 	_screens
 	_network
 	_update
 	## pre
 	cat <<%
 	Highlighted key to open menu
 	q to go back
 	= to edit menu
 	%
 
 	battery=$( upower -i /org/freedesktop/UPower/devices/DisplayDevice | grep -E 'percentage|time')
 	current_time=$(date +"%Hh%M.")
 	ssid="ssid:$( nmcli | grep "connected to " | sed 's/.*\( .*$\)/\1/' )"
 	echo "${ssid:-not connected}\n$current_time\n$battery"
 	ip -4 -br  addr | tail -n1 | tr -s ' ' | cut -f3 -d" "
 
 	## react
 	;; (s) zenu+ screens
 	;; (n) zenu+ network
 	;; (u)
 		sudo apt update && sudo apt upgrade
 		read -k1
 
 ### Launching a specific submenu
 
 You might want to directly get access to a specific submenu without having to
 navigate through the tree, effectively overriding the default start menu
 `main`. To achieve this use the `from` option :
 
 	zenu.loop in path/to/zenu/menus from network
 
 `zenu` will be launched as if the `network` was the `main` menu.
 
 ### Editing an existing menu while inside zenu
 
 At any moment you can press the default key `=` and edit the current menu.
 Menus will be recompiled automatically. The `EDITOR` environnment variable will
 be read to know which text editor to use. If you wish to set it write
 
 	EDITOR=your-favorite-editor
 
 In the `rc` file of your shell (`.bashrc`, `.zshrc` etc). Alternatively you can
 specify the variable only for zenu when executing the command :
 
 	EDITOR=your-favorite-editor zenu.loop in path/to/menus
 
 If EDITOR is not set `vim` is used as the default editor.
 
 ### Creating a new menu inside zenu
 
 If you try to open a non existing menu with a `zenu+` command you will be asked
 wether you want to create said menu or not. If you do a dummy file will be
 created with the corresponding file name and opened in a text editor. Therefore
 if you want to create a new menu inside zenu you can edit the current menu with
 `=`, add a `zenu+ menu-to-create` command, exit the editor and execute said
 command.
 
 The `EDITOR` environnment variable will be read to know which text editor to
 use. If you wish to set it write
 
 	EDITOR=your-favorite-editor
 
 In the `rc` file of your shell (`.bashrc`, `.zshrc` etc). Alternatively you can
 specify the variable only for zenu when executing the command :
 
 	EDITOR=your-favorite-editor zenu.loop in path/to/menus
 
 If EDITOR is not set `vim` is used as the default editor.
 
 ### Changing defaults
 
 #### "Go up a menu" key and "edit menu" key
 
 To modify the default "go up a menu" key from enter to something else edit the
 case around line 26 of `bin/build`.
 
 For example, to substitute enter for both backspace and `q`
 
 	...
 	case "\$zenu_key"
 	in (\$'') zenu--
 	;; (\$'q') zenu--
 	...
 
 The editing key `=` can be changed in a similar way.
 
 #### Activator key declarator
 
 To modify which character has to precede the activator key for a command from `_`
 to say `~` swap the `_` characters in these two lines in `bin/build` :
 
 	;; (face   | -f) sed -En '/^##/q;s/_(.)/\1/g;s/^/ /p' "$@"
 	[...]
 	sed -En '/^##/q;s/(.*)_((.).*)/\3 \1\2 /;p' "$@" | awk '
 
 to
 
 	;; (face   | -f) sed -En '/^##/q;s/~(.)/\1/g;s/^/ /p' "$@"
 	[...]
 	sed -En '/^##/q;s/(.*)~((.).*)/\3 \1\2 /;p' "$@" | awk '
 
 You'll have to modify your menus accordingly. You can achieve this with this
 command (if you have a `sed` with the `-i` option) :
 
 	sed -iE '1,/## +pre/ s/_/~/' path/to/menus/*
 
 #### Default starting menu
 
 To modify the default starting menu from main to another file modify line 36 of
 zenu.zsh
 
 	zenu_stack=( anotherfile )
 
 #### Shortcut to the root
 
 It is possible to take a shortcut back to the root with the command :
 
 	zenu_stack=( main )
 
 This command could be added to all menus by adding a line to `bin/build` :
 
 	...
 	case "\$zenu_key"
 	in (\$'q') zenu--
 	in ('~')   zenu_stack=( main )
 	...
 
 Or to every menu with a sed script :
 
 	sed -Ei '$ a;; ("~") zenu_stack=( main )' path/to/menus/*
 
 Take note that if you use another root menu than `main` you'll have to adapt
 the above.

git clone git://bebou.netlib.re/zenu
Log | Files | Refs |

README.nope (4068B)

 # A CLI menu engine in ZSH
 
 Written by Marc Chantreux
 
 ## How to install
 
 First, source the ZSH functions written in zenu.zsh in your `.zshrc` file
 
 	echo ". path/to/zenu/zenu.zsh" >> path/to/.zshrc
 
 Then provide menu files in a `menus` folder found at the root of this git
 project. Create it if it doesn't exist. Examples given in the `eg` folder can
 be copied to `menus`.
 
 Build the script files
 
 	make
 
 And launch the loop
 
 	zenu.loop in path/to/zenu/menus
 
 If you used the examples given in `eg` you should see
 
 	 mail
 	 recent (MRU)
 	 jobs
 	 notes
 	 network
 
 With some letters highlighted.
 
 You can make the command `zenu.loop in path/to/zenu/menus` easily accessible
 in you `.zshrc` file :
 
 	# With a shortcut (ctrl+w)
 	bindkey -s '' 'zenu.loop in path/to/zenu/menus'
 	# With an alias
 	alias z="zenu.loop in path/to/zenu/menus"
 
 ## Usage
 
 To enter submenus and/or execute commands, use the highlighted key. By default
 to go back one menu press enter.
 
 ### Creating / Customizing menus
 
 Menus are stored in the `menus` folder. The file named `main` is the default
 starting menu. A menu is defined as
 
   1. A list of commands and/or submenus with one given key being its activator
 
 This part of the main menu given as an example looks like :
 
 	mail
 	recent (MRU)
 	jobs
 	notes
 	network
 
 by default the character preceding the activator key has to be `ctrl+_` : ``.
 
   2. An optional "pre" section
 
 This section is arbitrary zsh code executed before zenu listens for a key
 press. It can be used to make the following section easier to write or print
 information below the menu section. By default this section starts after a `##
 pre` comment in our menu declaration.
 
 In the `network` menu given as an example in the `eg` folder this section the
 pre section is as follows :
 
 	## pre
 	local save=$zenu_store/network_interface
 	local state=$zenu_store/network_state
 	local nif=
 	touch $save
 	read nif < $save
 	echo
 	ip -br a | sed -r "
 		s/ /! /   # separator for pick
 		s/^/   /  # margin
 	"| tee $state |
 	sed "/${nif:-é}!/s/.*/\x1b[7m&\x1b[m/;s/!/ /"
 
 Which (at least on my machine) prints basic information about the machines
 network interfaces. This could also by a simple heredoc to document key
 shortcuts or what each command does.
 
   3. A scripting "react" section
 
 This section is where you declare what each command should do. It starts with a
 `## react` command and follows the zsh `case` syntax.
 
 The react section of the main menu in the eg folder :
 
 	## react
 	;; (m) zenu+ mail
 	;; (r) zenu+ mru
 	;; (w) zenu+ network
 	;; (n) vim ~p/start +'cd %:h' +'setf roguemode'
 
 The line should always start with `;;`. The letter between brackets should
 match with the corresponding activator key in the first section. In the first
 section the "m" key was identified as activating the `mail` command therefore
 corresponding reaction should be `;; (m) command`.
 
 What comes after the activation key is arbitrary zsh code. If a submenu is to be
 opened the `zenu+` function, written in `zenu.zsh` can be used with the name of
 the submenu passed as an argument. For it to work the given argument has to exist
 as a menu file in `menus`.
 
 The entire main menu file with an added small tutorial would be :
 
 	mail
 	recent (MRU)
 	jobs
 	notes
 	network
 	## pre
 	<<% cat
 	Welcome to your menu
 	Press the highlighted keys to navigate and enter to go back up one menu
 	%
 	## react
 	;; (m) zenu+ mail
 	;; (r) zenu+ mru
 	;; (w) zenu+ network
 	;; (n) vim ~p/start +'cd %:h' +'setf roguemode'
 
 ### Changing defaults
 
 #### "Go up a menu" key
 
 To modify the default "go up a menu" key from enter to something else edit the
 case around line 26 of `bin/build`.
 
 For example, to substitute enter for both backspace and `q`
 
 	...
 	case "\$zenu_key"
 	in (\$'') zenu--
 	;; (\$'q') zenu--
 	...
 
 #### Activator key declarator
 
 To modify which character has to precede the activator key for a command from
 ctrl+_ to something else
 
 #### Default starting menu
 
 To modify the default starting menu from main to another file modify line 36 of
 zenu.zsh
 
 	zenu_stack=( anotherfile )