TGAC/irods_bash_completer

Name: irods_bash_completer

Owner: Earlham Institute

Description: A tool to allow the iRODS client icommands to have auto-complete functionality within Bash

Created: 2018-04-04 16:40:51.0

Updated: 2018-04-11 14:55:51.0

Pushed: 2018-04-11 14:55:49.0

Homepage: null

Size: 24

Language: C

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

iRODS Bash Completer

This is a tool to allow the iRODS client icommands to have auto-complete functionality within Bash.

Installation

The installation consists of two parts; building the command-line tool and configuring the bash auto-completion script.

Building the command line tool

The tool is built with the given makefile. You will need to have the iRODS header files and runtime libraries to build it. By default, these will be in `/usr/include/irods/and ``/usr/lib/`, however, if you have installed iRODS to a non-standard location, simply adjust theIRODS_HOME`` variable in the makefile to the appropriate value.

You can then build the tool by running

 all

which will create the tool at `build/irods_bash_completer`. You can copy this executable to wherever you want to run it from.

Configuring the Bash auto-completion

The Bash auto-completion script is at `bash/icommands.d. You will need to edit the ``opts` line in this file to match the location of where you copied the executableirods_bash_completer`` to. For example if you installed it in `/usr/bin`, then you would need to change the line from

s=`/home/billy/Projects/irods_bash_completer/build/irods_bash_completer ${cur}`

to

s=`/usr/bin/irods_bash_completer ${cur}`

At the bottom of the file it contains the auto-completion configurations for a number of the iRODS icommands. If you wish to add more entries then just add them in the format of:

lete -F _irods_completer <icommand to add>

Once you have and this needs to be copied into the directory into `/etc/bash_completion.d/`.

Credits

iRODS Bash Completer is written by Simon Tyrrell. For questions or support, contact me directly or via the Earlham Institute page.

License

Copyright (c) 2018, Earlham Institute under the Apache License Version 2.0.


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.