Blame Functions/Help/help_searchIndex.sh

4c79b5
#!/bin/bash
4c79b5
#
0211a4
# help_searchIndex.sh -- This function does an index search inside the
4c79b5
# info document.
4c79b5
#
9f5f2e
# Copyright (C) 2009-2011 Alain Reguera Delgado
4c79b5
# 
7cd8e9
# This program is free software; you can redistribute it and/or
7cd8e9
# modify it under the terms of the GNU General Public License as
7cd8e9
# published by the Free Software Foundation; either version 2 of the
7cd8e9
# License, or (at your option) any later version.
4c79b5
# 
4c79b5
# This program is distributed in the hope that it will be useful, but
4c79b5
# WITHOUT ANY WARRANTY; without even the implied warranty of
4c79b5
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
4c79b5
# General Public License for more details.
4c79b5
#
4c79b5
# You should have received a copy of the GNU General Public License
4c79b5
# along with this program; if not, write to the Free Software
4c79b5
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
4c79b5
# USA.
4c79b5
# 
4c79b5
# ----------------------------------------------------------------------
418249
# $Id$
4c79b5
# ----------------------------------------------------------------------
4c79b5
0211a4
function help_searchIndex {
4c79b5
476079
    # Check flag filter. By default flag filter has the `.+' value
476079
    # which is not very descriptive in the sake of an index-search.
476079
    # So, when no value is passed through --filter option use top node
476079
    # as default value for index-search.
476079
    if [[ "$FLAG_FILTER" == '.+' ]];then
476079
        cli_printMessage "`gettext "Use the \\\`--filter' option to define the search pattern."`" 'AsErrorLine'
476079
        cli_printMessage "$(caller)" 'AsToKnowMoreLine'
476079
    fi
476079
476079
    # Print action message.
476079
    cli_printMessage "${MANUAL_BASEFILE}.info.bz2" 'AsReadingLine'
476079
476079
    # Execute info command to perform an index-search.
5285d6
    /usr/bin/info --index-search="$FLAG_FILTER" --file=${MANUAL_BASEFILE}.info.bz2
4c79b5
4c79b5
}