added Chapters

- Introduction
- Configuration Files
- UI Icon Names
to info documentation
list 'make info' in make help message
parent 3034ec49
......@@ -17,6 +17,7 @@ help_message () {
echo -e " ${ORANGE}help${WHITE} *|${GREEN} Display this help message
${ORANGE}pot${WHITE} *|${GREEN} Generate .pot files
${ORANGE}po${WHITE} *|${GREEN} Update .po files
${ORANGE}info${WHITE} *|${GREEN} Generate Info documentation
${ORANGE}news${WHITE} *|${GREEN} Generate NEWS file
${ORANGE}build${WHITE} *|${GREEN} Build necessary files
${ORANGE}install${WHITE} *|${GREEN} Install ${APP_NAME}
......
......@@ -144,6 +144,5 @@ between. For more detailed information see the or git log.
- Updated german translation
*
<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
......@@ -159,8 +159,7 @@ maximum python versions for configure messages)
@item Updated german translation
@end itemize
@item <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
@end itemize
@c <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
......
......@@ -76,6 +76,8 @@ notice identical to this one.
* Configuration Files:: Notes on various configuration files used
* Shell Functions:: Extra shell functions provided by BashStyle-NG
* User Interface Icons:: Icon names for UI
@end menu
@node Copying, Introduction, Top, Top
......@@ -83,7 +85,7 @@ notice identical to this one.
@cindex Copying
@node Introduction, Installation, Copying, Top
@chapter Introduction
@include userdoc_introduction.texi
@cindex Introduction
@node Installation, Changelog, Introduction, Top
......@@ -143,9 +145,13 @@ notice identical to this one.
@cindex Custom Prompt Builder
@node Configuration Files, Shell Functions, Custom Prompt Builder, Top
@chapter Configuration Files
@include userdoc_configurationfiles.texi
@cindex Configuration Files
@node Shell Functions, Top, Configuration Files, Top
@node Shell Functions, User Interface Icons, Configuration Files, Top
@chapter Shell Functions
@cindex Shell Functions
@node User Interface Icons, Top, Shell Functions, Top
@include userdoc_iconnames.texi
@cindex User Interface Icons
@c -*- texinfo -*-
@chapter Configuration Files
While BashStyle-NG is able to auto-generate the configuration files based on
your choices in the UI, you might want to do manual additions aswell.
@heading Main Configuration Files
@itemize @bullet
@item Factory Configuration: INSTALLATION_PREFIX/share/bashstyle-ng/bs-ng.ini
@item Vendor Configuration: /etc/bs-ng_vendor.ini
@item User Configuration: ~/.bs-ng.ini
@item User Backup Configuration: ~/.bs-ng.ini.save
@end itemize
@heading Configuration File Handling
@itemize @bullet
@item Configuration Files are versioned using the @code{ini_version} parameter,
which ensures your User or Vendor configuration is up to date.
@item If no User Configuration exists, BashStyle-NG will create the default one
using
@itemize +
@item Vendor Configuration (if it exists and has the latest @code{ini_version})
@item Factory Configuration
@end itemize
@item If the User Configuation is outdated, BashStyle-NG will update it using
@itemize +
@item Vendor Configuration (if it exists and has the latest @code{ini_version})
@item Factory Configuration
@end itemize
@item If the User Configuation is malformed, BashStyle-NG will try to restore it
using
@itemize +
@item User Backup Configuration (if it exists and has the latest @code{ini_version})
@end itemize
if that is not possible, it will create the default one using
@itemize +
@item Vendor Configuration (if it exists and has the latest @code{ini_version})
@item Factory Configuration
@end itemize
@end itemize
@heading Additional Configuration Files
@itemize @bullet
@item ~/.inputrc.custom: custom non-managed readline settings, loaded after ~/.inputrc
@item ~/.vimrc.custom: custom non-managed vim settings, loaded after ~/.vimrc
@item ~/.bashstyle.custom: custom non-managed bash settings, always loaded
after BashStyle-NG start so variables and functions provided by BashStyle-NG can
reliably be used
@end itemize
@heading Configuration File handling in User Interface
In the BashStyle-NG @code{Configuration Files} section you are able to
@itemize @bullet
@item view versions of the configuration files
@item backup your User configuration
@item restore User Backup configuration
@item restore Vendor configuration (if it exists and has the lastest
@code{ini_version}), else Factory configuration
@item edit ~/.bashrc (uses xdg-open)
@item edit ~/.bashstyle.custom (uses xdg-open)
@item edit ~/.inputrc.custom (uses xdg-open)
@item edit ~/.vimrc.custom (uses xdg-open)
@end itemize
@heading Style Hooks in ~/.bashstyle.custom
Some of the provided prompt styles allow be hooked into, so that some parts
of them can be customized. Those hooks consist of a color variable and a hook
function and should reside in ~/.bashstyle.custom.
Those are not set when the prompts are loaded in the Custom Promp Builder.
The following hooks are available
@itemize @bullet
@item Separator Style
@itemize +
@item SEPA_1() / SEPA_1_COLOR
@item SEPA_2() / SEPA_2_COLOR
@end itemize
@item Vector Style
@itemize +
@item VECTOR_1() / VECTOR_1_COLOR
@item VECTOR_2() / VECTOR_2_COLOR
@end itemize
@item Floating Clock
@itemize +
@item CLOCK_1() / CLOCK_1_COLOR
@end itemize
@item Equinox Style
@itemize +
@item EQUINOX_1() / EQUINOX_1_COLOR
@end itemize
@item Elite Style
@itemize +
@item ELITE_1() / ELITE_1_COLOR
@end itemize
@item Power Style
@itemize +
@item POW_1() / POW_1_COLOR
@end itemize
@item Dirks Style
@itemize +
@item DIRKS_1() / DIRKS_1_COLOR
@item DIRKS_2() / DIRKS_2_COLOR
@end itemize
@item Sepa-NG Style
@itemize +
@item SEPA_NG_1() / SEPA_NG_1_COLOR
@end itemize
@item Quirk Style
@itemize +
@item QUIRK_1() / QUIRK_1_COLOR
@end itemize
@end itemize
@c -*- texinfo -*-
@chapter User Interface 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.
Those are 32x32 pixel icons, using the following names
@itemize @bullet
@item bs-ng = Application logo
@item bs-ng-advanced = Icon for 'Advanced' category in UI
@item bs-ng-alias = Icon for 'Alias' category in UI
@item bs-ng-config = Icon for 'Configuration' category in UI
@item bs-ng-custom = Icon for 'Custom Prompt Builder' in UI
@item bs-ng-git = Icon for 'GIT' category in UI
@item bs-ng-info = Icon for 'About Dialog' in UI
@item bs-ng-keys = Icon for 'Keybindings Setter' in UI
@item bs-ng-ls = Icon for 'LS Colors' category in UI
@item bs-ng-nano = Icon for 'Nano Configuration' in UI
@item bs-ng-readline = Icon for 'Readline Configuration' in UI
@item bs-ng-shopts = Icon for 'Shell Options Configuration' in UI
@item bs-ng-style = Icon for 'Style' category in UI
@item bs-ng-toolbox = Icon for 'Custom Prompt Builder Toolbox' in UI
@item bs-ng-vim = Icon for 'VIM Configuration' in UI
@end itemize
@c -*- texinfo -*-
@chapter Introduction
BashStyle-NG is a graphical tool and toolchain for changing the behaviour
and look'n'feel of Bash, Readline, Vim, Nano and GIT.
@heading What can BashStyle-NG do for you?
@itemize @bullet
@item Bash Settings
@itemize +
@item 12 fancy pre-defined prompt styles
@item colors are customizable
@item random text color possible
@item random prompt style for each session possible
@item create your own prompt using UI
@item customizing pre-defined ones possible
@item alternatively monochrome prompts instead of colored
@item colored manpages (without using most)
@item colored output from ls and grep (matches)
@item colors are customizable
@item rembering last visited directory (and restore upon new session)
@item customize bash history settings
@item lscd: customized variant of cd, showing content of directory after cd,
can create directories that don't exist, passing of customized ls parameters
possible
@item un/setting shopts (shell options) for Bash 4.3 / 4.0-4.2 / 3.2+
@item customizable completion blacklist, timeout, welcome message and more
@item sync history over simultaneously running sessions
@end itemize
@item Git Options
@itemize +
@item set GIT user name
@item set GIT mail address
@item set GIT editor for commit messages
@item set GIT colored output
@end itemize
@item Readline Options
@itemize +
@item un/set completion
@item un/set case sensitivity
@item un/set horizontal completion
@item un/set mark filetypes and folders
@item un/set include hidden files incompletion
@item customize almost 30 keybindings
@end itemize
@item Vi Improved Settings
@itemize +
@item un/set remember last position
@item un/set syntax highlighting
@item un/set auto indention
@item un/set case sensitive search
@item un/set incremental search
@item un/set display line numbers
@item un/set highlight current line/column
@item set dark or bright background
@item set line-wrap and tab-length
@item set color scheme
@item enable ruler/set ruler format
@end itemize
@item GNU Nano Settings
@itemize +
@item un/set search history
@item un/set syntax highlighting
@item un/set auto indention
@item un/set case sensitive search
@item fix backspace and numblock assignment
@end itemize
@item Extra Features and Functions
@itemize +
@item systemkit: show various system information, including cpu, system load,
used/free/total ram and more
@item 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)
@item math conversion functions: convasc, convbin, convdec, convhex, convoct,
convtemp. Convert between ascii, binary, decimal, hexadecimal, octal or
temperature units
@item random: create random strings (for example passwords) of various types
@item 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)
@item see INSTALL_PREFIX/share/bashstyle-ng/rc/functions/ for all
@end itemize
@end itemize
@heading Git repository access
You can get the latest in-development version by running
@itemize @bullet
@item git clone git://github.com/Nanolx/bashstyle-ng.git
@end itemize
@heading Translations
@itemize @bullet
@item Existing Translations [Translator]
@itemize +
@item de (German) [Christopher Roy Bratusek]
@end itemize
@item Visit https://www.transifex.com/projects/p/bs-ng/ and apply for a team
or request the creation of a new one.
@end itemize
@heading Submit Bugs for Feature Requests
Visit https://github.com/Nanolx/bashstyle-ng/issues
before reporting bugs please make sure that you got the latest stable
version of BashStyle-NG. 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.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment