xref: /freebsd/usr.sbin/bsdinstall/scripts/docsinstall (revision 734e82fe33aa764367791a7d603b383996c6b40b)
1#!/bin/sh
2#-
3# Copyright (c) 2011 Marc Fonvieille
4# Copyright (c) 2013-2015 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#
29############################################################ INCLUDES
30
31BSDCFG_SHARE="/usr/share/bsdconfig"
32. $BSDCFG_SHARE/common.subr || exit 1
33f_dprintf "%s: loading includes..." "$0"
34f_include $BSDCFG_SHARE/dialog.subr
35f_include $BSDCFG_SHARE/mustberoot.subr
36f_include $BSDCFG_SHARE/packages/packages.subr
37
38############################################################ CONFIGURATION
39
40#
41# List of languages to display (descriptions pulled from $msg_{lang}doc_desc)
42#
43: ${DOCSINSTALL_LANGS:=\
44	bn da de el en es fr hu id it ja ko mn nl pl pt ru tr zh_cn zh_tw \
45}
46
47############################################################ GLOBALS
48
49#
50# Strings that should be moved to an i18n file and loaded with f_include_lang()
51#
52hline_arrows_space_tab_enter="Use arrows, SPACE, TAB or ENTER"
53msg_bndoc_desc="Bengali Documentation"
54msg_cancel="Cancel"
55msg_dadoc_desc="Danish Documentation"
56msg_dedoc_desc="German Documentation"
57msg_docsinstall_menu_text="This menu allows you to install the whole documentation set from\nthe $OSNAME 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."
58msg_eldoc_desc="Greek Documentation"
59msg_endoc_desc="English Documentation (recommended)"
60msg_esdoc_desc="Spanish Documentation"
61msg_frdoc_desc="French Documentation"
62msg_freebsd_documentation_installation="$OSNAME Documentation Installation"
63msg_freebsd_installer="$OSNAME Installer"
64msg_hudoc_desc="Hungarian Documentation"
65msg_iddoc_desc="Indonesian Documentation"
66msg_itdoc_desc="Italian Documentation"
67msg_jadoc_desc="Japanese Documentation"
68msg_kodoc_desc="Korean Documentation"
69msg_mndoc_desc="Mongolian Documentation"
70msg_nldoc_desc="Dutch Documentation"
71msg_ok="OK"
72msg_pldoc_desc="Polish Documentation"
73msg_ptdoc_desc="Portuguese Documentation"
74msg_rudoc_desc="Russian Documentation"
75msg_trdoc_desc="Turkish Documentation"
76msg_zh_cndoc_desc="Simplified Chinese Documentation"
77msg_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#
85dialog_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		--separate-output               \
123		--hline \"\$hline\"             \
124		--ok-label \"\$msg_ok\"         \
125		--cancel-label \"\$msg_cancel\" \
126		--checklist \"\$prompt\"        \
127		$height $width $rows            \
128		$check_list                     \
129		2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD
130	)
131	local retval=$?
132	f_dialog_menutag_store -s "$selected"
133	return $retval
134}
135
136############################################################ MAIN
137
138#
139# Initialize
140#
141f_dialog_title "$msg_freebsd_documentation_installation"
142f_dialog_backtitle "$msg_freebsd_installer"
143f_mustberoot_init
144
145#
146# Launch application main menu
147#
148dialog_menu_main || f_die
149f_dialog_menutag_fetch selected
150
151# Let pkg_add be able to use name servers
152f_quietly cp -f $BSDINSTALL_TMPETC/resolv.conf $BSDINSTALL_CHROOT/etc/
153
154#
155# Install each of the selected packages
156#
157docsets=""
158for lang in $selected; do
159	docsets="$docsets $lang-freebsd-doc"
160done
161
162ASSUME_ALWAYS_YES=YES chroot $BSDINSTALL_CHROOT pkg install $docsets
163
164################################################################################
165# END
166################################################################################
167