├── .gitignore
├── META-INF
└── com
│ └── google
│ └── android
│ ├── updater-script
│ └── update-binary
├── system
└── bin
│ ├── bootctl.bin
│ └── bootctl
├── module.prop
├── .gitattributes
├── uninstall.sh
├── README.md
├── customize.sh
├── common
└── functions.sh
└── LICENSE
/.gitignore:
--------------------------------------------------------------------------------
1 | __MACOSX
2 | .DS_Store
3 |
--------------------------------------------------------------------------------
/META-INF/com/google/android/updater-script:
--------------------------------------------------------------------------------
1 | #MAGISK
2 |
--------------------------------------------------------------------------------
/system/bin/bootctl.bin:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/roihershberg/bootctl-binary/HEAD/system/bin/bootctl.bin
--------------------------------------------------------------------------------
/system/bin/bootctl:
--------------------------------------------------------------------------------
1 | #!/system/bin/sh
2 |
3 | export LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:/vendor/lib64
4 | /system/bin/bootctl.bin $*
5 |
--------------------------------------------------------------------------------
/module.prop:
--------------------------------------------------------------------------------
1 | id=bootctl-binary
2 | name=Bootctl Binary
3 | version=v2.2
4 | versionCode=4
5 | author=Roee Hershberg
6 | description=Adds the bootctl binary for A/B slots handling
7 |
--------------------------------------------------------------------------------
/.gitattributes:
--------------------------------------------------------------------------------
1 | # Declare files that will always have LF line endings on checkout.
2 | *.sh text eol=lf
3 | *.prop text eol=lf
4 | *.md text eol=lf
5 | *.xml text eol=lf
6 | META-INF/** text eol=lf
7 |
8 | # Denote all files that are truly binary and should not be modified.
9 | common/addon/**/tools/** binary
10 |
--------------------------------------------------------------------------------
/uninstall.sh:
--------------------------------------------------------------------------------
1 | # Don't modify anything after this
2 | if [ -f $INFO ]; then
3 | while read LINE; do
4 | if [ "$(echo -n $LINE | tail -c 1)" == "~" ]; then
5 | continue
6 | elif [ -f "$LINE~" ]; then
7 | mv -f $LINE~ $LINE
8 | else
9 | rm -f $LINE
10 | while true; do
11 | LINE=$(dirname $LINE)
12 | [ "$(ls -A $LINE 2>/dev/null)" ] && break 1 || rm -rf $LINE
13 | done
14 | fi
15 | done < $INFO
16 | rm -f $INFO
17 | fi
18 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 |
Magisk Bootctl Binary
2 |
3 | This is a simple Magisk Module for adding the bootctl binary. It is used for A/B slot handling.
4 | It can be executed from terminal (with su) or with a GUI wrapper like Switch My Slot.
5 |
6 | The bootctl binary is taken from this repo.
7 |
8 | This module is based on MMT-Ex.
9 |
--------------------------------------------------------------------------------
/customize.sh:
--------------------------------------------------------------------------------
1 | ##########################################################################################
2 | #
3 | # MMT Extended Config Script
4 | #
5 | ##########################################################################################
6 |
7 | ##########################################################################################
8 | # Config Flags
9 | ##########################################################################################
10 |
11 | # Uncomment and change 'MINAPI' and 'MAXAPI' to the minimum and maximum android version for your mod
12 | # Uncomment DYNLIB if you want libs installed to vendor for oreo+ and system for anything older
13 | # Uncomment DEBUG if you want full debug logs (saved to /sdcard)
14 | MINAPI=21
15 | MAXAPI=33
16 | #DYNLIB=true
17 | #DEBUG=true
18 |
19 | ##########################################################################################
20 | # Replace list
21 | ##########################################################################################
22 |
23 | # List all directories you want to directly replace in the system
24 | # Check the documentations for more info why you would need this
25 |
26 | # Construct your list in the following format
27 | # This is an example
28 | REPLACE_EXAMPLE="
29 | /system/app/Youtube
30 | /system/priv-app/SystemUI
31 | /system/priv-app/Settings
32 | /system/framework
33 | "
34 |
35 | # Construct your own list here
36 | REPLACE="
37 | "
38 |
39 | ##########################################################################################
40 | # Permissions
41 | ##########################################################################################
42 |
43 | set_permissions() {
44 | : # Remove this if adding to this function
45 |
46 | # Note that all files/folders in magisk module directory have the $MODPATH prefix - keep this prefix on all of your files/folders
47 | # Some examples:
48 |
49 | # For directories (includes files in them):
50 | # set_perm_recursive (default: u:object_r:system_file:s0)
51 |
52 | # set_perm_recursive $MODPATH/system/lib 0 0 0755 0644
53 | # set_perm_recursive $MODPATH/system/vendor/lib/soundfx 0 0 0755 0644
54 |
55 | # For files (not in directories taken care of above)
56 | # set_perm (default: u:object_r:system_file:s0)
57 |
58 | # set_perm $MODPATH/system/lib/libart.so 0 0 0644
59 | # set_perm /data/local/tmp/file.txt 0 0 644
60 |
61 | set_perm $MODPATH/system/bin/bootctl 0 0 750
62 | set_perm $MODPATH/system/bin/bootctl.bin 0 0 750
63 | }
64 |
65 | ##########################################################################################
66 | # MMT Extended Logic - Don't modify anything after this
67 | ##########################################################################################
68 |
69 | SKIPUNZIP=1
70 | unzip -qjo "$ZIPFILE" 'common/functions.sh' -d $TMPDIR >&2
71 | . $TMPDIR/functions.sh
72 |
--------------------------------------------------------------------------------
/META-INF/com/google/android/update-binary:
--------------------------------------------------------------------------------
1 | #!/sbin/sh
2 |
3 | #################
4 | # Initialization
5 | #################
6 |
7 | umask 022
8 |
9 | # echo before loading util_functions
10 | ui_print() { echo "$1"; }
11 |
12 | require_new_magisk() {
13 | ui_print "*******************************"
14 | ui_print " Please install Magisk v20.0+! "
15 | ui_print "*******************************"
16 | exit 1
17 | }
18 |
19 | #########################
20 | # Load util_functions.sh
21 | #########################
22 |
23 | OUTFD=$2
24 | ZIPFILE=$3
25 |
26 | mount /data 2>/dev/null
27 |
28 | [ -f /data/adb/magisk/util_functions.sh ] || require_new_magisk
29 | . /data/adb/magisk/util_functions.sh
30 | [ $MAGISK_VER_CODE -lt 20000 ] && require_new_magisk
31 |
32 | if [ $MAGISK_VER_CODE -ge 20400 ]; then
33 | # New Magisk have complete installation logic within util_functions.sh
34 | install_module
35 | exit 0
36 | fi
37 |
38 | #################
39 | # Legacy Support
40 | #################
41 |
42 | TMPDIR=/dev/tmp
43 | PERSISTDIR=/sbin/.magisk/mirror/persist
44 |
45 | is_legacy_script() {
46 | unzip -l "$ZIPFILE" install.sh | grep -q install.sh
47 | return $?
48 | }
49 |
50 | print_modname() {
51 | local authlen len namelen pounds
52 | namelen=`echo -n $MODNAME | wc -c`
53 | authlen=$((`echo -n $MODAUTH | wc -c` + 3))
54 | [ $namelen -gt $authlen ] && len=$namelen || len=$authlen
55 | len=$((len + 2))
56 | pounds=$(printf "%${len}s" | tr ' ' '*')
57 | ui_print "$pounds"
58 | ui_print " $MODNAME "
59 | ui_print " by $MODAUTH "
60 | ui_print "$pounds"
61 | ui_print "*******************"
62 | ui_print " Powered by Magisk "
63 | ui_print "*******************"
64 | }
65 |
66 | # Override abort as old scripts have some issues
67 | abort() {
68 | ui_print "$1"
69 | $BOOTMODE || recovery_cleanup
70 | [ -n $MODPATH ] && rm -rf $MODPATH
71 | rm -rf $TMPDIR
72 | exit 1
73 | }
74 |
75 | rm -rf $TMPDIR 2>/dev/null
76 | mkdir -p $TMPDIR
77 |
78 | # Preperation for flashable zips
79 | setup_flashable
80 |
81 | # Mount partitions
82 | mount_partitions
83 |
84 | # Detect version and architecture
85 | api_level_arch_detect
86 |
87 | # Setup busybox and binaries
88 | $BOOTMODE && boot_actions || recovery_actions
89 |
90 | ##############
91 | # Preparation
92 | ##############
93 |
94 | # Extract prop file
95 | unzip -o "$ZIPFILE" module.prop -d $TMPDIR >&2
96 | [ ! -f $TMPDIR/module.prop ] && abort "! Unable to extract zip file!"
97 |
98 | $BOOTMODE && MODDIRNAME=modules_update || MODDIRNAME=modules
99 | MODULEROOT=$NVBASE/$MODDIRNAME
100 | MODID=`grep_prop id $TMPDIR/module.prop`
101 | MODNAME=`grep_prop name $TMPDIR/module.prop`
102 | MODAUTH=`grep_prop author $TMPDIR/module.prop`
103 | MODPATH=$MODULEROOT/$MODID
104 |
105 | # Create mod paths
106 | rm -rf $MODPATH 2>/dev/null
107 | mkdir -p $MODPATH
108 |
109 | ##########
110 | # Install
111 | ##########
112 |
113 | if is_legacy_script; then
114 | unzip -oj "$ZIPFILE" module.prop install.sh uninstall.sh 'common/*' -d $TMPDIR >&2
115 |
116 | # Load install script
117 | . $TMPDIR/install.sh
118 |
119 | # Callbacks
120 | print_modname
121 | on_install
122 |
123 | # Custom uninstaller
124 | [ -f $TMPDIR/uninstall.sh ] && cp -af $TMPDIR/uninstall.sh $MODPATH/uninstall.sh
125 |
126 | # Skip mount
127 | $SKIPMOUNT && touch $MODPATH/skip_mount
128 |
129 | # prop file
130 | $PROPFILE && cp -af $TMPDIR/system.prop $MODPATH/system.prop
131 |
132 | # Module info
133 | cp -af $TMPDIR/module.prop $MODPATH/module.prop
134 |
135 | # post-fs-data scripts
136 | $POSTFSDATA && cp -af $TMPDIR/post-fs-data.sh $MODPATH/post-fs-data.sh
137 |
138 | # service scripts
139 | $LATESTARTSERVICE && cp -af $TMPDIR/service.sh $MODPATH/service.sh
140 |
141 | ui_print "- Setting permissions"
142 | set_permissions
143 | else
144 | print_modname
145 |
146 | unzip -o "$ZIPFILE" customize.sh -d $MODPATH >&2
147 |
148 | if ! grep -q '^SKIPUNZIP=1$' $MODPATH/customize.sh 2>/dev/null; then
149 | ui_print "- Extracting module files"
150 | unzip -o "$ZIPFILE" -x 'META-INF/*' -d $MODPATH >&2
151 |
152 | # Default permissions
153 | set_perm_recursive $MODPATH 0 0 0755 0644
154 | fi
155 |
156 | # Load customization script
157 | [ -f $MODPATH/customize.sh ] && . $MODPATH/customize.sh
158 | fi
159 |
160 | # Handle replace folders
161 | for TARGET in $REPLACE; do
162 | ui_print "- Replace target: $TARGET"
163 | mktouch $MODPATH$TARGET/.replace
164 | done
165 |
166 | if $BOOTMODE; then
167 | # Update info for Magisk Manager
168 | mktouch $NVBASE/modules/$MODID/update
169 | cp -af $MODPATH/module.prop $NVBASE/modules/$MODID/module.prop
170 | fi
171 |
172 | # Copy over custom sepolicy rules
173 | if [ -f $MODPATH/sepolicy.rule -a -e $PERSISTDIR ]; then
174 | ui_print "- Installing custom sepolicy patch"
175 | # Remove old recovery logs (which may be filling partition) to make room
176 | rm -f $PERSISTDIR/cache/recovery/*
177 | PERSISTMOD=$PERSISTDIR/magisk/$MODID
178 | mkdir -p $PERSISTMOD
179 | cp -af $MODPATH/sepolicy.rule $PERSISTMOD/sepolicy.rule || abort "! Insufficient partition size"
180 | fi
181 |
182 | # Remove stuffs that don't belong to modules
183 | rm -rf \
184 | $MODPATH/system/placeholder $MODPATH/customize.sh \
185 | $MODPATH/README.md $MODPATH/.git* 2>/dev/null
186 |
187 | #############
188 | # Finalizing
189 | #############
190 |
191 | cd /
192 | $BOOTMODE || recovery_cleanup
193 | rm -rf $TMPDIR
194 |
195 | ui_print "- Done"
196 | exit 0
197 |
--------------------------------------------------------------------------------
/common/functions.sh:
--------------------------------------------------------------------------------
1 | ##########################################################################################
2 | #
3 | # MMT Extended Utility Functions
4 | #
5 | ##########################################################################################
6 |
7 | abort() {
8 | ui_print "$1"
9 | rm -rf $MODPATH 2>/dev/null
10 | cleanup
11 | rm -rf $TMPDIR 2>/dev/null
12 | exit 1
13 | }
14 |
15 | cleanup() {
16 | rm -rf $MODPATH/common 2>/dev/null
17 | }
18 |
19 | device_check() {
20 | local opt=`getopt -o dm -- "$@"` type=device
21 | eval set -- "$opt"
22 | while true; do
23 | case "$1" in
24 | -d) local type=device; shift;;
25 | -m) local type=manufacturer; shift;;
26 | --) shift; break;;
27 | *) abort "Invalid device_check argument $1! Aborting!";;
28 | esac
29 | done
30 | local prop=$(echo "$1" | tr '[:upper:]' '[:lower:]')
31 | for i in /system /vendor /odm /product; do
32 | if [ -f $i/build.prop ]; then
33 | for j in "ro.product.$type" "ro.build.$type" "ro.product.vendor.$type" "ro.vendor.product.$type"; do
34 | [ "$(sed -n "s/^$j=//p" $i/build.prop 2>/dev/null | head -n 1 | tr '[:upper:]' '[:lower:]')" == "$prop" ] && return 0
35 | done
36 | [ "$type" == "device" ] && [ "$(sed -n "s/^"ro.build.product"=//p" $i/build.prop 2>/dev/null | head -n 1 | tr '[:upper:]' '[:lower:]')" == "$prop" ] && return 0
37 | fi
38 | done
39 | return 1
40 | }
41 |
42 | cp_ch() {
43 | local opt=`getopt -o nr -- "$@"` BAK=true UBAK=true FOL=false
44 | eval set -- "$opt"
45 | while true; do
46 | case "$1" in
47 | -n) UBAK=false; shift;;
48 | -r) FOL=true; shift;;
49 | --) shift; break;;
50 | *) abort "Invalid cp_ch argument $1! Aborting!";;
51 | esac
52 | done
53 | local SRC="$1" DEST="$2" OFILES="$1"
54 | $FOL && local OFILES=$(find $SRC -type f 2>/dev/null)
55 | [ -z $3 ] && PERM=0644 || PERM=$3
56 | case "$DEST" in
57 | $TMPDIR/*|$MODULEROOT/*|$NVBASE/modules/$MODID/*) BAK=false;;
58 | esac
59 | for OFILE in ${OFILES}; do
60 | if $FOL; then
61 | if [ "$(basename $SRC)" == "$(basename $DEST)" ]; then
62 | local FILE=$(echo $OFILE | sed "s|$SRC|$DEST|")
63 | else
64 | local FILE=$(echo $OFILE | sed "s|$SRC|$DEST/$(basename $SRC)|")
65 | fi
66 | else
67 | [ -d "$DEST" ] && local FILE="$DEST/$(basename $SRC)" || local FILE="$DEST"
68 | fi
69 | if $BAK && $UBAK; then
70 | [ ! "$(grep "$FILE$" $INFO 2>/dev/null)" ] && echo "$FILE" >> $INFO
71 | [ -f "$FILE" -a ! -f "$FILE~" ] && { mv -f $FILE $FILE~; echo "$FILE~" >> $INFO; }
72 | elif $BAK; then
73 | [ ! "$(grep "$FILE$" $INFO 2>/dev/null)" ] && echo "$FILE" >> $INFO
74 | fi
75 | install -D -m $PERM "$OFILE" "$FILE"
76 | done
77 | }
78 |
79 | install_script() {
80 | case "$1" in
81 | -l) shift; local INPATH=$NVBASE/service.d;;
82 | -p) shift; local INPATH=$NVBASE/post-fs-data.d;;
83 | *) local INPATH=$NVBASE/service.d;;
84 | esac
85 | [ "$(grep "#!/system/bin/sh" $1)" ] || sed -i "1i #!/system/bin/sh" $1
86 | local i; for i in "MODPATH" "LIBDIR" "MODID" "INFO" "MODDIR"; do
87 | case $i in
88 | "MODPATH") sed -i "1a $i=$NVBASE/modules/$MODID" $1;;
89 | "MODDIR") sed -i "1a $i=\${0%/*}" $1;;
90 | *) sed -i "1a $i=$(eval echo \$$i)" $1;;
91 | esac
92 | done
93 | [ "$1" == "$MODPATH/uninstall.sh" ] && return 0
94 | case $(basename $1) in
95 | post-fs-data.sh|service.sh) ;;
96 | *) cp_ch -n $1 $INPATH/$(basename $1) 0755;;
97 | esac
98 | }
99 |
100 | prop_process() {
101 | sed -i -e "/^#/d" -e "/^ *$/d" $1
102 | [ -f $MODPATH/system.prop ] || mktouch $MODPATH/system.prop
103 | while read LINE; do
104 | echo "$LINE" >> $MODPATH/system.prop
105 | done < $1
106 | }
107 |
108 | # Credits
109 | ui_print "**************************************"
110 | ui_print "* MMT Extended by Zackptg5 @ XDA *"
111 | ui_print "**************************************"
112 | ui_print " "
113 |
114 | # Check for min/max api version
115 | [ -z $MINAPI ] || { [ $API -lt $MINAPI ] && abort "! Your system API of $API is less than the minimum api of $MINAPI! Aborting!"; }
116 | [ -z $MAXAPI ] || { [ $API -gt $MAXAPI ] && abort "! Your system API of $API is greater than the maximum api of $MAXAPI! Aborting!"; }
117 |
118 | # Set variables
119 | [ $API -lt 26 ] && DYNLIB=false
120 | [ -z $DYNLIB ] && DYNLIB=false
121 | [ -z $DEBUG ] && DEBUG=false
122 | INFO=$NVBASE/modules/.$MODID-files
123 | ORIGDIR="$MAGISKTMP/mirror"
124 | if $DYNLIB; then
125 | LIBPATCH="\/vendor"
126 | LIBDIR=/system/vendor
127 | else
128 | LIBPATCH="\/system"
129 | LIBDIR=/system
130 | fi
131 | if ! $BOOTMODE; then
132 | ui_print "- Only uninstall is supported in recovery"
133 | ui_print " Uninstalling!"
134 | touch $MODPATH/remove
135 | [ -s $INFO ] && install_script $MODPATH/uninstall.sh || rm -f $INFO $MODPATH/uninstall.sh
136 | recovery_cleanup
137 | cleanup
138 | rm -rf $NVBASE/modules_update/$MODID $TMPDIR 2>/dev/null
139 | exit 0
140 | fi
141 |
142 | # Debug
143 | if $DEBUG; then
144 | ui_print "- Debug mode"
145 | ui_print " Module install log will include debug info"
146 | ui_print " Be sure to save it after module install"
147 | set -x
148 | fi
149 |
150 | # Extract files
151 | ui_print "- Extracting module files"
152 | unzip -o "$ZIPFILE" -x 'META-INF/*' 'common/functions.sh' -d $MODPATH >&2
153 | [ -f "$MODPATH/common/addon.tar.xz" ] && tar -xf $MODPATH/common/addon.tar.xz -C $MODPATH/common 2>/dev/null
154 |
155 | # Run addons
156 | if [ "$(ls -A $MODPATH/common/addon/*/install.sh 2>/dev/null)" ]; then
157 | ui_print " "; ui_print "- Running Addons -"
158 | for i in $MODPATH/common/addon/*/install.sh; do
159 | ui_print " Running $(echo $i | sed -r "s|$MODPATH/common/addon/(.*)/install.sh|\1|")..."
160 | . $i
161 | done
162 | fi
163 |
164 | # Remove files outside of module directory
165 | ui_print "- Removing old files"
166 |
167 | if [ -f $INFO ]; then
168 | while read LINE; do
169 | if [ "$(echo -n $LINE | tail -c 1)" == "~" ]; then
170 | continue
171 | elif [ -f "$LINE~" ]; then
172 | mv -f $LINE~ $LINE
173 | else
174 | rm -f $LINE
175 | while true; do
176 | LINE=$(dirname $LINE)
177 | [ "$(ls -A $LINE 2>/dev/null)" ] && break 1 || rm -rf $LINE
178 | done
179 | fi
180 | done < $INFO
181 | rm -f $INFO
182 | fi
183 |
184 | ### Install
185 | ui_print "- Installing"
186 |
187 | [ -f "$MODPATH/common/install.sh" ] && . $MODPATH/common/install.sh
188 |
189 | ui_print " Installing for $ARCH SDK $API device..."
190 | # Remove comments from files and place them, add blank line to end if not already present
191 | for i in $(find $MODPATH -type f -name "*.sh" -o -name "*.prop" -o -name "*.rule"); do
192 | [ -f $i ] && { sed -i -e "/^#/d" -e "/^ *$/d" $i; [ "$(tail -1 $i)" ] && echo "" >> $i; } || continue
193 | case $i in
194 | "$MODPATH/service.sh") install_script -l $i;;
195 | "$MODPATH/post-fs-data.sh") install_script -p $i;;
196 | "$MODPATH/uninstall.sh") if [ -s $INFO ] || [ "$(head -n1 $MODPATH/uninstall.sh)" != "# Don't modify anything after this" ]; then
197 | install_script $MODPATH/uninstall.sh
198 | else
199 | rm -f $INFO $MODPATH/uninstall.sh
200 | fi;;
201 | esac
202 | done
203 |
204 | $IS64BIT || for i in $(find $MODPATH/system -type d -name "lib64"); do rm -rf $i 2>/dev/null; done
205 | [ -d "/system/priv-app" ] || mv -f $MODPATH/system/priv-app $MODPATH/system/app 2>/dev/null
206 | [ -d "/system/xbin" ] || mv -f $MODPATH/system/xbin $MODPATH/system/bin 2>/dev/null
207 | if $DYNLIB; then
208 | for FILE in $(find $MODPATH/system/lib* -type f 2>/dev/null | sed "s|$MODPATH/system/||"); do
209 | [ -s $MODPATH/system/$FILE ] || continue
210 | case $FILE in
211 | lib*/modules/*) continue;;
212 | esac
213 | mkdir -p $(dirname $MODPATH/system/vendor/$FILE)
214 | mv -f $MODPATH/system/$FILE $MODPATH/system/vendor/$FILE
215 | [ "$(ls -A `dirname $MODPATH/system/$FILE`)" ] || rm -rf `dirname $MODPATH/system/$FILE`
216 | done
217 | # Delete empty lib folders (busybox find doesn't have this capability)
218 | toybox find $MODPATH/system/lib* -type d -empty -delete >/dev/null 2>&1
219 | fi
220 |
221 | # Set permissions
222 | ui_print " "
223 | ui_print "- Setting Permissions"
224 | set_perm_recursive $MODPATH 0 0 0755 0644
225 | if [ -d $MODPATH/system/vendor ]; then
226 | set_perm_recursive $MODPATH/system/vendor 0 0 0755 0644 u:object_r:vendor_file:s0
227 | [ -d $MODPATH/system/vendor/app ] && set_perm_recursive $MODPATH/system/vendor/app 0 0 0755 0644 u:object_r:vendor_app_file:s0
228 | [ -d $MODPATH/system/vendor/etc ] && set_perm_recursive $MODPATH/system/vendor/etc 0 0 0755 0644 u:object_r:vendor_configs_file:s0
229 | [ -d $MODPATH/system/vendor/overlay ] && set_perm_recursive $MODPATH/system/vendor/overlay 0 0 0755 0644 u:object_r:vendor_overlay_file:s0
230 | for FILE in $(find $MODPATH/system/vendor -type f -name *".apk"); do
231 | [ -f $FILE ] && chcon u:object_r:vendor_app_file:s0 $FILE
232 | done
233 | fi
234 | set_permissions
235 |
236 | # Complete install
237 | cleanup
238 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 2, June 1991
3 |
4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
6 | Everyone is permitted to copy and distribute verbatim copies
7 | of this license document, but changing it is not allowed.
8 |
9 | Preamble
10 |
11 | The licenses for most software are designed to take away your
12 | freedom to share and change it. By contrast, the GNU General Public
13 | License is intended to guarantee your freedom to share and change free
14 | software--to make sure the software is free for all its users. This
15 | General Public License applies to most of the Free Software
16 | Foundation's software and to any other program whose authors commit to
17 | using it. (Some other Free Software Foundation software is covered by
18 | the GNU Lesser General Public License instead.) You can apply it to
19 | your programs, too.
20 |
21 | When we speak of free software, we are referring to freedom, not
22 | price. Our General Public Licenses are designed to make sure that you
23 | have the freedom to distribute copies of free software (and charge for
24 | this service if you wish), that you receive source code or can get it
25 | if you want it, that you can change the software or use pieces of it
26 | in new free programs; and that you know you can do these things.
27 |
28 | To protect your rights, we need to make restrictions that forbid
29 | anyone to deny you these rights or to ask you to surrender the rights.
30 | These restrictions translate to certain responsibilities for you if you
31 | distribute copies of the software, or if you modify it.
32 |
33 | For example, if you distribute copies of such a program, whether
34 | gratis or for a fee, you must give the recipients all the rights that
35 | you have. You must make sure that they, too, receive or can get the
36 | source code. And you must show them these terms so they know their
37 | rights.
38 |
39 | We protect your rights with two steps: (1) copyright the software, and
40 | (2) offer you this license which gives you legal permission to copy,
41 | distribute and/or modify the software.
42 |
43 | Also, for each author's protection and ours, we want to make certain
44 | that everyone understands that there is no warranty for this free
45 | software. If the software is modified by someone else and passed on, we
46 | want its recipients to know that what they have is not the original, so
47 | that any problems introduced by others will not reflect on the original
48 | authors' reputations.
49 |
50 | Finally, any free program is threatened constantly by software
51 | patents. We wish to avoid the danger that redistributors of a free
52 | program will individually obtain patent licenses, in effect making the
53 | program proprietary. To prevent this, we have made it clear that any
54 | patent must be licensed for everyone's free use or not licensed at all.
55 |
56 | The precise terms and conditions for copying, distribution and
57 | modification follow.
58 |
59 | GNU GENERAL PUBLIC LICENSE
60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
61 |
62 | 0. This License applies to any program or other work which contains
63 | a notice placed by the copyright holder saying it may be distributed
64 | under the terms of this General Public License. The "Program", below,
65 | refers to any such program or work, and a "work based on the Program"
66 | means either the Program or any derivative work under copyright law:
67 | that is to say, a work containing the Program or a portion of it,
68 | either verbatim or with modifications and/or translated into another
69 | language. (Hereinafter, translation is included without limitation in
70 | the term "modification".) Each licensee is addressed as "you".
71 |
72 | Activities other than copying, distribution and modification are not
73 | covered by this License; they are outside its scope. The act of
74 | running the Program is not restricted, and the output from the Program
75 | is covered only if its contents constitute a work based on the
76 | Program (independent of having been made by running the Program).
77 | Whether that is true depends on what the Program does.
78 |
79 | 1. You may copy and distribute verbatim copies of the Program's
80 | source code as you receive it, in any medium, provided that you
81 | conspicuously and appropriately publish on each copy an appropriate
82 | copyright notice and disclaimer of warranty; keep intact all the
83 | notices that refer to this License and to the absence of any warranty;
84 | and give any other recipients of the Program a copy of this License
85 | along with the Program.
86 |
87 | You may charge a fee for the physical act of transferring a copy, and
88 | you may at your option offer warranty protection in exchange for a fee.
89 |
90 | 2. You may modify your copy or copies of the Program or any portion
91 | of it, thus forming a work based on the Program, and copy and
92 | distribute such modifications or work under the terms of Section 1
93 | above, provided that you also meet all of these conditions:
94 |
95 | a) You must cause the modified files to carry prominent notices
96 | stating that you changed the files and the date of any change.
97 |
98 | b) You must cause any work that you distribute or publish, that in
99 | whole or in part contains or is derived from the Program or any
100 | part thereof, to be licensed as a whole at no charge to all third
101 | parties under the terms of this License.
102 |
103 | c) If the modified program normally reads commands interactively
104 | when run, you must cause it, when started running for such
105 | interactive use in the most ordinary way, to print or display an
106 | announcement including an appropriate copyright notice and a
107 | notice that there is no warranty (or else, saying that you provide
108 | a warranty) and that users may redistribute the program under
109 | these conditions, and telling the user how to view a copy of this
110 | License. (Exception: if the Program itself is interactive but
111 | does not normally print such an announcement, your work based on
112 | the Program is not required to print an announcement.)
113 |
114 | These requirements apply to the modified work as a whole. If
115 | identifiable sections of that work are not derived from the Program,
116 | and can be reasonably considered independent and separate works in
117 | themselves, then this License, and its terms, do not apply to those
118 | sections when you distribute them as separate works. But when you
119 | distribute the same sections as part of a whole which is a work based
120 | on the Program, the distribution of the whole must be on the terms of
121 | this License, whose permissions for other licensees extend to the
122 | entire whole, and thus to each and every part regardless of who wrote it.
123 |
124 | Thus, it is not the intent of this section to claim rights or contest
125 | your rights to work written entirely by you; rather, the intent is to
126 | exercise the right to control the distribution of derivative or
127 | collective works based on the Program.
128 |
129 | In addition, mere aggregation of another work not based on the Program
130 | with the Program (or with a work based on the Program) on a volume of
131 | a storage or distribution medium does not bring the other work under
132 | the scope of this License.
133 |
134 | 3. You may copy and distribute the Program (or a work based on it,
135 | under Section 2) in object code or executable form under the terms of
136 | Sections 1 and 2 above provided that you also do one of the following:
137 |
138 | a) Accompany it with the complete corresponding machine-readable
139 | source code, which must be distributed under the terms of Sections
140 | 1 and 2 above on a medium customarily used for software interchange; or,
141 |
142 | b) Accompany it with a written offer, valid for at least three
143 | years, to give any third party, for a charge no more than your
144 | cost of physically performing source distribution, a complete
145 | machine-readable copy of the corresponding source code, to be
146 | distributed under the terms of Sections 1 and 2 above on a medium
147 | customarily used for software interchange; or,
148 |
149 | c) Accompany it with the information you received as to the offer
150 | to distribute corresponding source code. (This alternative is
151 | allowed only for noncommercial distribution and only if you
152 | received the program in object code or executable form with such
153 | an offer, in accord with Subsection b above.)
154 |
155 | The source code for a work means the preferred form of the work for
156 | making modifications to it. For an executable work, complete source
157 | code means all the source code for all modules it contains, plus any
158 | associated interface definition files, plus the scripts used to
159 | control compilation and installation of the executable. However, as a
160 | special exception, the source code distributed need not include
161 | anything that is normally distributed (in either source or binary
162 | form) with the major components (compiler, kernel, and so on) of the
163 | operating system on which the executable runs, unless that component
164 | itself accompanies the executable.
165 |
166 | If distribution of executable or object code is made by offering
167 | access to copy from a designated place, then offering equivalent
168 | access to copy the source code from the same place counts as
169 | distribution of the source code, even though third parties are not
170 | compelled to copy the source along with the object code.
171 |
172 | 4. You may not copy, modify, sublicense, or distribute the Program
173 | except as expressly provided under this License. Any attempt
174 | otherwise to copy, modify, sublicense or distribute the Program is
175 | void, and will automatically terminate your rights under this License.
176 | However, parties who have received copies, or rights, from you under
177 | this License will not have their licenses terminated so long as such
178 | parties remain in full compliance.
179 |
180 | 5. You are not required to accept this License, since you have not
181 | signed it. However, nothing else grants you permission to modify or
182 | distribute the Program or its derivative works. These actions are
183 | prohibited by law if you do not accept this License. Therefore, by
184 | modifying or distributing the Program (or any work based on the
185 | Program), you indicate your acceptance of this License to do so, and
186 | all its terms and conditions for copying, distributing or modifying
187 | the Program or works based on it.
188 |
189 | 6. Each time you redistribute the Program (or any work based on the
190 | Program), the recipient automatically receives a license from the
191 | original licensor to copy, distribute or modify the Program subject to
192 | these terms and conditions. You may not impose any further
193 | restrictions on the recipients' exercise of the rights granted herein.
194 | You are not responsible for enforcing compliance by third parties to
195 | this License.
196 |
197 | 7. If, as a consequence of a court judgment or allegation of patent
198 | infringement or for any other reason (not limited to patent issues),
199 | conditions are imposed on you (whether by court order, agreement or
200 | otherwise) that contradict the conditions of this License, they do not
201 | excuse you from the conditions of this License. If you cannot
202 | distribute so as to satisfy simultaneously your obligations under this
203 | License and any other pertinent obligations, then as a consequence you
204 | may not distribute the Program at all. For example, if a patent
205 | license would not permit royalty-free redistribution of the Program by
206 | all those who receive copies directly or indirectly through you, then
207 | the only way you could satisfy both it and this License would be to
208 | refrain entirely from distribution of the Program.
209 |
210 | If any portion of this section is held invalid or unenforceable under
211 | any particular circumstance, the balance of the section is intended to
212 | apply and the section as a whole is intended to apply in other
213 | circumstances.
214 |
215 | It is not the purpose of this section to induce you to infringe any
216 | patents or other property right claims or to contest validity of any
217 | such claims; this section has the sole purpose of protecting the
218 | integrity of the free software distribution system, which is
219 | implemented by public license practices. Many people have made
220 | generous contributions to the wide range of software distributed
221 | through that system in reliance on consistent application of that
222 | system; it is up to the author/donor to decide if he or she is willing
223 | to distribute software through any other system and a licensee cannot
224 | impose that choice.
225 |
226 | This section is intended to make thoroughly clear what is believed to
227 | be a consequence of the rest of this License.
228 |
229 | 8. If the distribution and/or use of the Program is restricted in
230 | certain countries either by patents or by copyrighted interfaces, the
231 | original copyright holder who places the Program under this License
232 | may add an explicit geographical distribution limitation excluding
233 | those countries, so that distribution is permitted only in or among
234 | countries not thus excluded. In such case, this License incorporates
235 | the limitation as if written in the body of this License.
236 |
237 | 9. The Free Software Foundation may publish revised and/or new versions
238 | of the General Public License from time to time. Such new versions will
239 | be similar in spirit to the present version, but may differ in detail to
240 | address new problems or concerns.
241 |
242 | Each version is given a distinguishing version number. If the Program
243 | specifies a version number of this License which applies to it and "any
244 | later version", you have the option of following the terms and conditions
245 | either of that version or of any later version published by the Free
246 | Software Foundation. If the Program does not specify a version number of
247 | this License, you may choose any version ever published by the Free Software
248 | Foundation.
249 |
250 | 10. If you wish to incorporate parts of the Program into other free
251 | programs whose distribution conditions are different, write to the author
252 | to ask for permission. For software which is copyrighted by the Free
253 | Software Foundation, write to the Free Software Foundation; we sometimes
254 | make exceptions for this. Our decision will be guided by the two goals
255 | of preserving the free status of all derivatives of our free software and
256 | of promoting the sharing and reuse of software generally.
257 |
258 | NO WARRANTY
259 |
260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
268 | REPAIR OR CORRECTION.
269 |
270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
278 | POSSIBILITY OF SUCH DAMAGES.
279 |
280 | END OF TERMS AND CONDITIONS
281 |
282 | How to Apply These Terms to Your New Programs
283 |
284 | If you develop a new program, and you want it to be of the greatest
285 | possible use to the public, the best way to achieve this is to make it
286 | free software which everyone can redistribute and change under these terms.
287 |
288 | To do so, attach the following notices to the program. It is safest
289 | to attach them to the start of each source file to most effectively
290 | convey the exclusion of warranty; and each file should have at least
291 | the "copyright" line and a pointer to where the full notice is found.
292 |
293 |
294 | Copyright (C)
295 |
296 | This program is free software; you can redistribute it and/or modify
297 | it under the terms of the GNU General Public License as published by
298 | the Free Software Foundation; either version 2 of the License, or
299 | (at your option) any later version.
300 |
301 | This program is distributed in the hope that it will be useful,
302 | but WITHOUT ANY WARRANTY; without even the implied warranty of
303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
304 | GNU General Public License for more details.
305 |
306 | You should have received a copy of the GNU General Public License along
307 | with this program; if not, write to the Free Software Foundation, Inc.,
308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
309 |
310 | Also add information on how to contact you by electronic and paper mail.
311 |
312 | If the program is interactive, make it output a short notice like this
313 | when it starts in an interactive mode:
314 |
315 | Gnomovision version 69, Copyright (C) year name of author
316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
317 | This is free software, and you are welcome to redistribute it
318 | under certain conditions; type `show c' for details.
319 |
320 | The hypothetical commands `show w' and `show c' should show the appropriate
321 | parts of the General Public License. Of course, the commands you use may
322 | be called something other than `show w' and `show c'; they could even be
323 | mouse-clicks or menu items--whatever suits your program.
324 |
325 | You should also get your employer (if you work as a programmer) or your
326 | school, if any, to sign a "copyright disclaimer" for the program, if
327 | necessary. Here is a sample; alter the names:
328 |
329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program
330 | `Gnomovision' (which makes passes at compilers) written by James Hacker.
331 |
332 | , 1 April 1989
333 | Ty Coon, President of Vice
334 |
335 | This General Public License does not permit incorporating your program into
336 | proprietary programs. If your program is a subroutine library, you may
337 | consider it more useful to permit linking proprietary applications with the
338 | library. If this is what you want to do, use the GNU Lesser General
339 | Public License instead of this License.
340 |
--------------------------------------------------------------------------------