update to utils/archive.sh script to include man pages

Author: phyver

.github/workflows/latest_game_archive.yml

@@ -22,7 +22,7 @@ jobs:
 
       - name: "Creating the archive"
         run: |
-          git fetch --tags --force && ./utils/archive.sh
+          git fetch --tags --force && ./utils/gameshell_archive.sh
 
       - uses: "marvinpinto/action-automatic-releases@latest"
         with:

.github/workflows/tag_release.yml

@@ -20,7 +20,7 @@ jobs:
 
       - name: "Creating the archive"
         run: |
-          git fetch --tags --force && ./utils/archive.sh
+          git fetch --tags --force && ./utils/gameshell_archive.sh
 
       - uses: "marvinpinto/action-automatic-releases@latest"
         with:

Dockerfile

@@ -45,7 +45,7 @@ ADD --chown=gsh-user:gsh-user https://github.com/phyver/GameShell/releases/downl
 ### if you prefer to use a local customized version, comment the preceeding
 ### ADD ...
 ### line and uncomment the next one
-### (NOTE that you need to have generated a "gameshell.sh" file with GSH_ROOT/utils/archive.sh
+### (NOTE that you need to have generated a "gameshell.sh" file with GSH_ROOT/utils/gameshell_archive.sh
 # COPY gameshell.sh .
 
 ENTRYPOINT ["bash", "./gameshell.sh"]

Makefile

@@ -36,22 +36,22 @@ new: i18n/template.pot
 
 ## check that the auto.sh scripts work as expected
 check: clean
-	./utils/archive.sh -at -N "game shell (1)"
+	./utils/gameshell_archive.sh -at -N "game shell (1)"
 	./"game shell (1).sh" -q -c 'gsh systemconfig; for _ in $$(seq 50); do gsh auto --abort < <(echo gsh); done; gsh stat'
 
 ## check that the auto.sh scripts work as expected, in verbose mode
 check-verbose: clean
-	./utils/archive.sh -at -N "game shell (1)"
+	./utils/gameshell_archive.sh -at -N "game shell (1)"
 	./"game shell (1).sh" -Dq -c 'gsh systemconfig; for _ in $$(seq 50); do gsh auto --abort; done; gsh stat'
 
 ## run all the test.sh and auto.sh scripts
 tests-bash: clean
-	./utils/archive.sh -at -N "game shell (1)"
+	./utils/gameshell_archive.sh -at -N "game shell (1)"
 	./"game shell (1).sh" -Bdq -c 'gsh systemconfig; for _ in $$(seq 50); do gsh goal|cat; gsh test --abort; gsh auto --abort; done; gsh stat'
 
 ## run all the test.sh and auto.sh scripts
 tests-zsh: clean
-	./utils/archive.sh -at -N "game shell (1)"
+	./utils/gameshell_archive.sh -at -N "game shell (1)"
 	./"game shell (1).sh" -Zdq -c 'gsh systemconfig; for _ in $$(seq 50); do gsh goal|cat; gsh test --abort; gsh auto --abort; done; gsh stat'
 
 clean:

doc/faq.md

@@ -54,7 +54,7 @@ Q. Can I use GameShell in the classroom?
 A. Of course! GameShell was initially developed for this very reason.
 
 Note that you can create your own GameShell archives with the missions you
-want using the `GSH_ROOT/utils/archive.sh` script. You should probably
+want using the `GSH_ROOT/utils/gameshell_archive.sh` script. You should probably
 
  - choose a password different from the default `gsh` (option `-p ...`)
  - activate the "passport" mode by default (option `-P`). The only

doc/gameshell.md

@@ -115,17 +115,17 @@ while creating missions (`gsh assert ...`, `gsh test`).
 
 
 
-Creating an executable archive
+Creating an executable [archive](archive)
 ------------------------------
 
-The script `utils/archive.sh` is used to create an executable archive to
+The script `utils/gameshell_archive.sh` is used to create an executable archive to
 distribute a (customized) version of GameShell.
 
 By default, it creates an archive with all the missions listed in the
 `$GSH_ROOT/missions/index.txt` file and with all the available translations.
 You can choose the missions you want by listing them on the command line:
 ```sh
-$ ./utils/archive.sh missions/basic/01_cd_tower missions/basic/02_cd.._cellar/ missions/basic/03_cd_HOME_throne/
+$ ./utils/gameshell_archive.sh missions/basic/01_cd_tower missions/basic/02_cd.._cellar/ missions/basic/03_cd_HOME_throne/
 ```
 If a directory contains an `index.txt` file, all the missions listed in it
 will be included. You can also give an `index.txt` file directly on the
@@ -147,5 +147,5 @@ You can customize the archive with the following options
 
 More options are available and listed in the output of
 ```sh
-$ ./utils/archive.sh -h
+$ ./utils/gameshell_archive.sh -h
 ```

doc/misc.md

@@ -36,10 +36,10 @@ $ ./GameShell/start.sh
 ### 3/ from an executable archive
 
 This is the easiest way to distribute GameShell to a group of students. Once you've
-cloned the repository, create an executable archive with the `archive.sh` script:
+cloned the repository, create an executable archive with the `gameshell_archive.sh` script:
 ```sh
 $ cd GameShell
-$ ./utils/archive.sh
+$ ./utils/gameshell_archive.sh
 copy missions
   -> copy basic/03_cd_HOME_throne
   -> copy basic/04_mkdir_chest

scripts/progress_bar

@@ -208,7 +208,7 @@ animation() {
 
   # NOTE: disabling echoing in terminal during animation doesn't always work in zsh!
   # running
-  # ./utils/archive.sh -a missions/stdin_stdout_stderr/04_stderr_dev-null_grimoires; ./gameshell.sh -Dqc "gsh auto"
+  # ./utils/makeshell_archive.sh -a missions/stdin_stdout_stderr/04_stderr_dev-null_grimoires; ./gameshell.sh -Dqc "gsh auto"
   # loops!
   # Removing the stty -echo / stty echo makes the problem go away.
   # I'm not sure what happens...

utils/archive.sh renamed to utils/gameshell_archive.sh

@@ -163,15 +163,15 @@ mkdir "$TMP_DIR/$NAME"
 # copy source files
 # NOTE: macOS' cp doesn't have '--archive', and '-a' is not POSIX.
 # use POSIX options to make sure it is portable
-cp -RPp "$GSH_ROOT/start.sh" "$GSH_ROOT/scripts" "$GSH_ROOT/utils" "$GSH_ROOT/lib" "$GSH_ROOT/i18n" "$TMP_DIR/$NAME"
+cp -RPp "$GSH_ROOT/start.sh" "$GSH_ROOT/scripts" "$GSH_ROOT/utils" "$GSH_ROOT/lib" "$GSH_ROOT/i18n" "$GSH_ROOT/man" "$TMP_DIR/$NAME"
 
 
 # generate default index file
 ALL_INDEX_FILES=default.idx
 mkdir "$TMP_DIR/$NAME/missions"
 if ! make_index "$@" > "$TMP_DIR/$NAME/missions/default.idx"
 then
-  echo "Error: archive.sh, couldn't make default.idx"
+  echo "Error: gameshell_archive.sh, couldn't make default.idx"
   # --system makes GameShell use the standard rm utility instead of the "safe"
   # rm implemented in scripts/rm
   rm --system -rf "$TMP_DIR"
@@ -186,7 +186,7 @@ do
   ALL_INDEX_FILES="$ALL_INDEX_FILES:$(basename "$FILE")"
   if ! make_index "$FILE" > "$TMP_DIR/$NAME/missions/$(basename "$FILE")"
   then
-    echo "Error: archive.sh, couldn't make $(basename "$FILE")"
+    echo "Error: gameshell_archive.sh, couldn't make $(basename "$FILE")"
     # --system makes GameShell use the standard rm utility instead of the "safe"
     # rm implemented in scripts/rm
     rm --system -rf "$TMP_DIR"
@@ -297,6 +297,22 @@ then
       fi
     done
   done
+
+  # remove translated manual pages
+  find "$GSH_ROOT/man" -type d | while read -r dir
+  do
+    if [ "$(basename "$dir")" = "man1" ] || [ "$(basename "$dir")" = "man" ]
+    then
+      continue
+    fi
+    if ! keep_language "$dir" "$LANGUAGES"
+    then
+      # --system makes GameShell use the standard rm utility instead of the "safe"
+      # rm implemented in scripts/rm
+      printf "."
+      rm --system -rf "$dir"
+    fi
+  done
   echo
 fi
 
@@ -366,6 +382,9 @@ echo "removing unnecessary files"
   [ "$KEEP_TEST" -ne 1 ] && find ./missions -name "test.sh" | xargs rm --system -f
   [ "$KEEP_AUTO" -ne 1 ] && find ./missions -name auto.sh | xargs rm --system -f
   rm --system -rf "$GSH_ROOT/utils/"
+  rm --system -f "$GSH_ROOT/i18n/gamesh-commands"
+  rm --system -f "$GSH_ROOT/man/en"
+  rm --system -f "$GSH_ROOT/man/README" "$GSH_ROOT/i18n/gameshell-*help/README"
 )
 
 # change admin password