README 5.18 KB
Newer Older
1 2 3 4
BashStyle-NG

=== Introduction ===

Christopher Roy Bratusek's avatar
Christopher Roy Bratusek committed
5 6 7 8 9
 BashStyle-NG is a graphical tool and toolchain for changing the behaviour
 and look'n'feel of Bash, Readline, Vim, Nano and GIT.

 Possibilities include:
  Bash:
10
    - 12 fancy pre-defined prompt styles
Christopher Roy Bratusek's avatar
Christopher Roy Bratusek committed
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
      - colors are customizable
      - random text color possible
      - random prompt style for each session possible
      - create your own prompt using UI
        - customizing pre-defined ones possible
      - alternatively monochrome prompts instead of colored
    - colored manpages (without using most)
    - colored output from ls and grep (matches)
      - colors are customizable
    - rembering last visited directory (and restore upon new session)
    - customize bash history settings
    - lscd: customized variant of cd, showing content of directory
      after cd, can create directories that don't exist, passing of
      customized ls parameters possible
    - un/setting shopts (shell options) for Bash 4.3 / 4.0-4.2 / 3.2+
    - customizable completion blacklist, timeout, welcome message and more
  GIT:
    - set GIT user name
    - set GIT mail address
    - set GIT editor for commit messages
    - set GIT colored output
  Readline:
    - un/set completion
    - un/set case sensitivity
    - un/set horizontal completion
    - un/set mark filetypes and folders
    - un/set include hidden files incompletion
    - customize almost 30 keybindings
  VIM:
    - un/set remember last position
    - un/set syntax highlighting
    - un/set auto indention
    - un/set case sensitive search
    - un/set incremental search
    - un/set display line numbers
    - un/set highlight current line/column
    - set dark or bright background
    - set line-wrap and tab-length
    - set color scheme
    - enable ruler/set ruler format
  Nano:
    - un/set search history
    - un/set syntax highlighting
    - un/set auto indention
    - un/set case sensitive search
    - fix backspace and numblock assignment
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
  Extras:
    - several extra functions for daily use
      - systemkit: show various system information, including cpu, system load,
        used/free/total ram and more
      - gitkit: various companion functions for GIT, like exporting the repo
        (like 'svn export'), creating tar.gz/tar.bz2/tar.xz/.zip archives from
        repo, getting active branch/action/revision/revno from repo (for PS1)
      - math conversion functions: convasc, convbin, convdec, convhex, convoct,
        convtemp. Convert between ascii, binary, decimal, hexadecimal, octal or
        temperature units
      - random: create random strings (for example passwords) of various types
      - scripts for working with files: map (run a command on given files, for
        non-batch commands), batch (batch-perform actions on files), basefile
        (extract extension, filename with/without extension or filepath from
        full filename, similar to basename), randomfile (perform action on a
        random file, also has history, multiple executions support and more)
      - and several more (see /usr/share/bashstyle-ng/rc/functions/ for all)
74

75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95
=== Installation ===

Installation of BashStyle-NG is straight-forward. Configure and Make are
Bash scripts aswell, so no other tools needed for build. For a full list
of options see

* ./configure --help
* ./make --help

1)	Check dependencies:	./configure
2)	Build translations:	./make build
3)	Install BashStyle-NG:	sudo ./make install

Alternatively you can build a package for Debian-based distributions via

1)	apt-get install fakeroot dpkg-dev
2)	dpkg-buildpackage -rfakeroot

If there are missing dependencies either Configure or dpkg-buildpackage will
tell you. Optional dependencies are marked as recommended for Debian packages.

96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116
=== Program Icons ===

BashStyle-NG uses Oxygen icons by default (supplied), but if the icons exist
in your currently active GTK+ icon theme aswell, they will be used instead.

32x32 pixel icons:
	bs-ng		Application logo
	bs-ng-advanced	Icon for 'Advanced' category in UI
	bs-ng-alias	Icon for 'Alias' category in UI
	bs-ng-custom	Icon for 'Custom Prompt Builder' in UI
	bs-ng-git	Icon for 'GIT' category in UI
	bs-ng-info	Icon for 'About Dialog' in UI
	bs-ng-keys	Icon for 'Keybindings Setter' in UI
	bs-ng-ls	Icon for 'LS Colors' category in UI
	bs-ng-nano	Icon for 'Nano Configuration' in UI
	bs-ng-readline	Icon for 'Readline Configuration' in UI
	bs-ng-shopts	Icon for 'Shell Options Configuration' in UI
	bs-ng-style	Icon for 'Style' category in UI
	bs-ng-toolbox	Icon for 'Custom Prompt Builder Toolbox' in UI
	bs-ng-vim	Icon for 'VIM Configuration' in UI

117
=== GIT Access ===
118 119 120

You can get the latest in-development version by running:

Christopher Roy Bratusek's avatar
Christopher Roy Bratusek committed
121
git clone git://github.com/Nanolx/bashstyle-ng.git
122 123 124 125 126

=== Translations ===

*** Current Translations: ***

Christopher Roy Bratusek's avatar
Christopher Roy Bratusek committed
127
de (German) (Christopher Roy Bratusek)
128 129 130

*** New Translations: ***

131 132
Visit https://www.transifex.com/projects/p/bs-ng/ and apply for a team
or request the creation of a new one.
133

Christopher Roy Bratusek's avatar
Christopher Roy Bratusek committed
134
=== Bugs ===
135

Christopher Roy Bratusek's avatar
Christopher Roy Bratusek committed
136
Visit https://github.com/Nanolx/bashstyle-ng/issues
137

Christopher Roy Bratusek's avatar
Christopher Roy Bratusek committed
138 139 140 141
before reporting bugs please make sure that you got the latest stable
version of BashStyle-NG.

=== Features Requests ===
142

Christopher Roy Bratusek's avatar
Christopher Roy Bratusek committed
143 144
If you got an Feature Request or a new Idea for BashStyle-NG, then don't
hesitate to post it! If you can provide patches, then that's even better.