usr.sbin/bsdinstall/scripts/docsinstall

   1 #!/bin/sh
   2 #-
   3 # Copyright (c) 2011 Marc Fonvieille
   4 # Copyright (c) 2013 Devin Teske
   5 # All rights reserved.
   6 #
   7 # Redistribution and use in source and binary forms, with or without
   8 # modification, are permitted provided that the following conditions
   9 # are met:
  10 # 1. Redistributions of source code must retain the above copyright
  11 #    notice, this list of conditions and the following disclaimer.
  12 # 2. Redistributions in binary form must reproduce the above copyright
  13 #    notice, this list of conditions and the following disclaimer in the
  14 #    documentation and/or other materials provided with the distribution.
  15 #
  16 # THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 # ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20 # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 # OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 # HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 # SUCH DAMAGE.
  27 #
  28 # $FreeBSD$
  29 #
  30 ############################################################ INCLUDES
  31
  32 BSDCFG_SHARE="/usr/share/bsdconfig"
  33 . $BSDCFG_SHARE/common.subr || exit 1
  34 f_dprintf "%s: loading includes..." "$0"
  35 f_include $BSDCFG_SHARE/dialog.subr
  36 f_include $BSDCFG_SHARE/mustberoot.subr
  37 f_include $BSDCFG_SHARE/packages/packages.subr
  38
  39 ############################################################ CONFIGURATION
  40
  41 #
  42 # List of languages to display (descriptions pulled from $msg_{lang}doc_desc)
  43 #
  44 : ${DOCSINSTALL_LANGS:=\
  45         bn da de el en es fr hu it ja mn nl pl pt ru sr tr zh_cn zh_tw \
  46 }
  47
  48 ############################################################ GLOBALS
  49
  50 #
  51 # Strings that should be moved to an i18n file and loaded with f_include_lang()
  52 #
  53 hline_arrows_space_tab_enter="Use arrows, SPACE, TAB or ENTER"
  54 msg_bndoc_desc="Bengali Documentation"
  55 msg_cancel="Cancel"
  56 msg_dadoc_desc="Danish Documentation"
  57 msg_dedoc_desc="German Documentation"
  58 msg_docsinstall_menu_text="This menu allows you to install the whole documentation set from\nthe FreeBSD Documentation Project: Handbook, FAQ, and articles.\n\nPlease select the language versions you wish to install. At\nminimum, you should install the English version, the original\nversion of the documentation."
  59 msg_eldoc_desc="Greek Documentation"
  60 msg_endoc_desc="English Documentation (recommended)"
  61 msg_esdoc_desc="Spanish Documentation"
  62 msg_frdoc_desc="French Documentation"
  63 msg_freebsd_documentation_installation="FreeBSD Documentation Installation"
  64 msg_freebsd_installer="FreeBSD Installer"
  65 msg_hudoc_desc="Hungarian Documentation"
  66 msg_itdoc_desc="Italian Documentation"
  67 msg_jadoc_desc="Japanese Documentation"
  68 msg_mndoc_desc="Mongolian Documentation"
  69 msg_nldoc_desc="Dutch Documentation"
  70 msg_ok="OK"
  71 msg_pldoc_desc="Polish Documentation"
  72 msg_ptdoc_desc="Portuguese Documentation"
  73 msg_rudoc_desc="Russian Documentation"
  74 msg_srdoc_desc="Serbian Documentation"
  75 msg_trdoc_desc="Turkish Documentation"
  76 msg_zh_cndoc_desc="Simplified Chinese Documentation"
  77 msg_zh_twdoc_desc="Traditional Chinese Documentation"
  78
  79 ############################################################ FUNCTIONS
  80
  81 # dialog_menu_main
  82 #
  83 # Display the dialog(1)-based application main menu.
  84 #
  85 dialog_menu_main()
  86 {
  87         local title="$DIALOG_TITLE"
  88         local btitle="$DIALOG_BACKTITLE"
  89         local prompt="$msg_docsinstall_menu_text"
  90         local check_list= # Calculated below
  91         local hline="$hline_arrows_space_tab_enter"
  92
  93         local lang desc upper status
  94         for lang in $DOCSINSTALL_LANGS; do
  95                 # Fetch the i18n description to display
  96                 f_getvar msg_${lang}doc_desc desc
  97                 f_shell_escape "$desc" desc
  98
  99                 # Get default status for each language
 100                 upper=$( echo "$lang" | awk '{print toupper($0)}' )
 101                 case "$lang" in
 102                 en) f_getvar DIST_DOC_$upper:-on status ;;
 103                  *) f_getvar DIST_DOC_$upper:-off status
 104                 esac
 105
 106                 check_list="$check_list
 107                         '$lang' '$desc' '$status'
 108                 " # END-QUOTE
 109         done
 110
 111         local height width rows
 112         eval f_dialog_checklist_size height width rows \
 113                                      \"\$title\"  \
 114                                      \"\$btitle\" \
 115                                      \"\$prompt\" \
 116                                      \"\$hline\"  \
 117                                      $check_list
 118         local selected
 119         selected=$( eval $DIALOG \
 120                 --title \"\$title\"             \
 121                 --backtitle \"\$btitle\"        \
 122                 --hline \"\$hline\"             \
 123                 --ok-label \"\$msg_ok\"         \
 124                 --cancel-label \"\$msg_cancel\" \
 125                 --checklist \"\$prompt\"        \
 126                 $height $width $rows            \
 127                 $check_list                     \
 128                 2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD
 129         )
 130         local retval=$?
 131         f_dialog_menutag_store -s "$selected"
 132         return $retval
 133 }
 134
 135 ############################################################ MAIN
 136
 137 #
 138 # Initialize
 139 #
 140 f_dialog_title "$msg_freebsd_documentation_installation"
 141 f_dialog_backtitle "$msg_freebsd_installer"
 142 f_mustberoot_init
 143
 144 #
 145 # Launch application main menu
 146 #
 147 dialog_menu_main || f_die
 148 f_dialog_menutag_fetch selected
 149
 150 # Let pkg_add be able to use name servers
 151 f_quietly cp -f $BSDINSTALL_TMPETC/resolv.conf $BSDINSTALL_CHROOT/etc/
 152
 153 #
 154 # Install each of the selected packages
 155 #
 156 for lang in $selected; do
 157         f_package_add $lang-freebsd-doc || return $FAILURE
 158 done
 159
 160 ################################################################################
 161 # END
 162 ################################################################################