From 959ed5a65b80c1724825bc89c6eb2dd0b35c2e53 Mon Sep 17 00:00:00 2001
From: Claude Becker <becker@phys.ethz.ch>
Date: Fri, 7 Feb 2025 14:19:05 +0100
Subject: [PATCH] document spellchecking and add custom dict

---
 .dict.spl       | 1054 +++++++++++++++++++++++++++++++++++++++++++++++
 README.markdown |   18 +
 2 files changed, 1072 insertions(+)
 create mode 100644 .dict.spl

diff --git a/.dict.spl b/.dict.spl
new file mode 100644
index 00000000..10fc4eb1
--- /dev/null
+++ b/.dict.spl
@@ -0,0 +1,1054 @@
+personal_ws-1.1 en 1053 
+ACL
+ACLs
+ASA
+ASUS
+Ablage
+ActiveSync
+AddIns
+Adresse
+Affoltern
+Agisoft
+Alexandre
+Amdahls
+Anwendungsstart
+AnyConnect
+AppStore
+AppleTV
+Archiv
+Astrolib
+Auguste
+Autodiscover
+Automounter
+Autorun
+Autotools
+Axel
+BAUG
+BDB
+BTRFS
+BaNG
+Backport
+Backporting
+BackupBox
+BasicTeX
+Basisdienste
+Bearbeiten
+Berufsbildung
+Besucher
+BibDesk
+BibTeX
+BigBrother
+BinNMU
+Bitwarden
+CAPSLOCK
+CAcert
+CDN
+CGIs
+CHF
+CLI
+CMS
+CMake
+CPAN
+CPUs
+CQ
+CQs
+CRAN
+CSCS
+CUDA
+CalDAV
+CalDav
+CalDavSynchronizer
+CaldavSynchronizer
+CardDAV
+Citrix
+Cmd
+CommonMark
+Comsol
+Configurator
+Corel
+Cronjobs
+Ctrl
+Cyberduck
+Cygwin
+Cygwin's
+DALCO
+DAV
+DAVx
+DHCP
+DM
+DMs
+DN
+DNS
+DSA
+DUC
+DWORD
+Daint
+Dalco
+Datei
+Debianized
+Deskstar
+DigiCert
+Digitec
+Displayname
+Distributable
+DokuWiki
+Dom
+DomU
+DomUs
+Downsampling
+Duret
+DynDNS
+EAP
+EDU
+EFI
+ETH
+ETH's
+ETHIS
+ETHZ
+Einstellungen
+Elasticdump
+Else's
+Emailbot
+Erweitert
+Esc
+Eterm
+Ethis
+Evo
+ExtUtils
+FCGID
+FDTD
+Fi
+FileMaker
+FileVault
+FileZilla
+Firstlab
+FolderView
+Fortran
+GDL
+GEODATA
+GEOVITE
+GIT's
+GPIO
+GPT
+GPUMEM
+GPUs
+GSEG
+GSSAPI
+GTX
+GUID
+GXP
+Garmin
+GeForce
+Geforce
+Gehe
+GiB
+GitLab
+Globus
+Gmail
+Grafana
+GridFTP
+Grml
+Groupshare
+HDDs
+HOWTO
+HPC
+HPF
+HPT
+HTTPS
+HX
+Hauptausgang
+Hochschularchiv
+Hoengg
+Hof
+Homebrew
+HotSpots
+Hyperkitty
+Hönggerberg
+IDEs
+IDL
+IGP
+IMAP
+IMAPS
+IMAPd
+IPv
+IQE
+ISC's
+ISG
+ISG's
+ISLLightClient
+ITP
+Indesign
+InfluxDB
+InfluxData
+InfluxQL
+Informatikdienste
+Informatikdienste's
+Informatikkoordinator
+Inkscape
+Integrations
+IntelliSense
+Inventarführung
+IoT
+IsNGLEnforced
+JSON
+JetBrains
+Jetbrains
+Jinja
+Jitsi
+Jupyter
+JupyterHub
+KDE
+KVM
+KaTeX
+KaTex
+KeePass
+KeePassDX
+KeePassX
+KeePassXC
+Kerberos
+Keychain
+Knoppix
+Konqueror
+LDAP
+LDAPv
+LEDs
+LGA
+LLVM
+LTS
+LTSC
+LTSP
+LUID
+LUN
+LUNs
+LV
+LV's
+LVC
+LVM
+LVMchart
+LVs
+LaTeX
+LaTeXiT
+Lastname
+Leonhard
+Lernende
+Lockscreen
+Lucene
+Lumerical
+Lutz
+MBOX
+MBX
+MDA
+MDM
+MFP
+MOTD
+MSCHAPv
+MSI
+MTA
+MUA
+MXID
+MacPorts
+MacTeX
+MacTex
+MacVim
+Macports
+Maildir
+MakeMaker
+MakeMaker's
+Makefile
+Mathtype
+Maubot
+MediaWiki
+Mediawiki
+Memtest
+MiB
+Mis
+Modul
+Moodle
+MsysGIT
+NCCR
+NFS
+NFSv
+NIST
+NMU
+NOGUI
+NTP
+NTPs
+NUX
+Nemo
+NetCenter
+NetMOS
+NetworkManager
+Nheko
+O'Reilly
+OOBE
+OOM
+OnTheHub
+OneDrive
+OpenCL
+OpenGL
+OpenLDAP
+OpenPGP
+OpenProm
+OpenSSH
+Optionen
+PAE
+PCI
+PCIe
+PDFs
+PEAP
+PID
+PIDs
+POSIX
+PPA
+PSFTP
+PV
+PXE
+Phonebook
+PhotoScan
+Photogrammetry
+Photoshop
+Physik
+Piccard
+Piz
+Podman
+Polkit
+Polybox
+Polybuchhandlung
+PostDocs
+Postfix
+Postorius
+PuTTY
+PuTTY's
+PuTTYgen
+PyCharm
+QVGE
+Quadro
+Quaternion
+QuoVadis
+RDP
+RESTful
+RPs
+RRD
+RSA
+RSS
+RTF
+RWX
+Raspbian
+Readme
+Rechtssammlung
+RedHat
+Rektorat
+RemoteApp
+RemoteApps
+Roadmap
+Roundcube
+Rustup
+SCS
+SDK
+SDKs
+SERVERNAME
+SGID
+SHA
+SHARENAME
+SHM
+SIGKILL
+SLURM
+SMB
+SMTP
+SMTPS
+SNMP
+SOGo
+SSDs
+SSHFS
+SSHUTTLE
+SSID
+SSL
+STARTTLS
+STDERR
+STDIN
+STDOUT
+STRIX
+SWITCHfilesender
+SageMath
+Scribus
+SeaTools
+Seagate
+Sigils
+SkimNotes
+Sleepycat's
+Sogo
+Sonoma
+SpamBox
+Sprache
+Synchronizer
+Systemd's
+TBsync
+TCP
+TFTP
+THRM
+TIMTOWTDI
+TL'DR
+TLS
+TLSv
+TPM
+TPMs
+TSC
+TWiki
+TbSync
+TeXLive
+TeXShop
+TeamViewer
+Templating
+TightVNCViewer
+Tilman's
+TortoiseGIT
+UEFI
+UI
+UID
+UIDs
+URI
+USD
+UTF
+UTP
+UUID
+UUIDs
+UW
+Uncheck
+UnicodeIt
+Unpublish
+VBZ
+VFX
+VLAN
+VLC
+VMchart
+VNC
+VPN
+VPNStaff
+VPNStaffLogin
+VSCode
+Vaultwarden
+VeraCrypt
+Verantwortlichkeiten
+VirtualBox
+Visio
+Voreinstellungen
+WLAN
+WMs
+WPA
+WSGI
+Wahl
+WebDav
+WebRTC
+WebVPNStaff
+Webhook
+Webhooks
+WeeChat
+Wegleitung
+Wi
+WinSCP
+Wordpress
+XDG
+XFS
+XFree
+XMPP
+XMing
+XTaran
+XY
+Xcode
+Xen
+Xymon
+YY
+Yaru
+YourAppleTVProfile
+Yourname
+Zeit
+Zeitgeschichte
+Zentrum
+Zermatt
+Zilla
+Zürich
+acl
+acpi
+activations
+activesync
+addmembers
+adjtimex
+agisoft
+alioth
+alix
+alsa
+amd
+amhello
+anandtech
+anonymized
+ansible
+anzeigen
+apache
+api
+appdata
+appletv
+appservice
+arXiv
+archiver
+arxiv
+ata
+aterm
+auth
+authenticator
+autoconf
+autofs
+automake
+automount
+automountable
+automounted
+automounter
+automounting
+autotools
+autotrace
+backport
+backports
+badblocks
+baseDN
+beamer
+bei
+berlin
+bibkiosk
+bindfs
+bkp
+bool
+bootloader
+botton
+bpo
+brokenlinks
+btrfs
+bugfixes
+cacheable
+cadabra
+caldav
+caldavsynchronizer
+callisto
+casted
+cd
+cdimage
+cdrecord
+cfdisk
+cfg
+cgi
+cgid
+cgroup
+cgroups
+cgroupv
+cgtop
+changeroot
+checkboxes
+choosable
+chroot
+chroots
+ckgedit
+cli
+clocksource
+cloudcompare
+cmake
+codepage
+colmap
+conf
+config
+configs
+contrib
+cp
+cpu
+cpuburn
+cron
+cronjobs
+crunchers
+cryptographic
+cuDNN
+cuba
+cuda
+cudnn
+customizable
+daduke
+dar
+datasource
+datasources
+ddr
+de
+debian
+debootstrap
+debsums
+decrypt
+der
+dev
+devfs
+devtools
+dhclient
+dhcpclient
+discoverable
+diskless
+displayname
+distributable
+distro
+dito
+dk
+dlang
+dmail
+dns
+dokuwiki
+domainpart
+dotfiles
+downsample
+downsampled
+downsampling
+dphys
+dpkg
+drag'n'drop
+dropbox
+drs
+ds
+eSync
+eXile
+eb
+edu
+eduroam
+ee
+eg
+egw
+elasticsearch
+emailadress
+emailbot
+enu
+env
+eth
+etherpad
+ethz
+etup
+excalidraw
+exe
+exfat
+extlinux
+fTPM
+facebook
+faq
+fastboot
+fdisk
+ffcv
+fileinto
+filemaker
+fileservers
+filesystem
+filevault
+firefox
+firewalled
+firewire
+fluffychat
+fnord
+frac
+fs
+für
+gddr
+geant
+getty
+gid
+gif
+gitcore
+gitignore
+gitlab
+gittutorial
+globus
+gmt
+gna
+gnupg
+gnuplot
+goaccess
+gocr
+gomuks
+gpedit
+gpg
+gpu
+grafana
+graphviz
+greylisted
+groops
+groupdrives
+groupname
+groupshare
+groupshares
+guenther
+hange
+harddisk
+hd
+hda
+hdf
+hdfview
+heisenbridge
+heldpesk
+helpdesk
+hez
+hifi
+homeserver
+homeservers
+hookshot
+hostcritical
+hosters
+hostname
+hostnames
+howto
+hpa
+hpc
+hpf
+hph
+hpk
+hpp
+hpr
+hpt
+hpv
+hpz
+html
+htop
+htpasswd
+httpie
+hvc
+iCal
+iCalendar
+iCloud
+iPXE
+iPadOS
+iPython
+iSCSI
+iTerm
+ical
+ics
+ide
+idprinter
+ie
+iframe
+img
+influxdb
+infty
+initrd
+inittab
+inkscape
+integrations
+io
+ios
+iowait
+ipconfig
+ipcs
+ipps
+iptables
+ipython
+irc
+isg
+iso
+ists
+itshop
+jetbrains
+jitsi
+johndoe
+joinable
+jpeg
+jpg
+js
+kB
+katex
+keepassxc
+keychain
+kibana
+kopf
+languageselect
+largetifftools
+latexmk
+ldap
+lenny
+linux
+linuxws
+localhost
+localpart
+lockdown
+lockscreen
+loopback
+loopthrough
+lst
+ltsp
+lvmchart
+lzo
+mDNS
+macOS
+macaulay
+macos
+macws
+mailserver
+maintainer's
+manpage
+manpages
+mathematica
+maths
+maubot
+mbxcat
+mc
+mcedit
+md
+meep
+mem
+memorysticks
+mepp
+meshlab
+mfa
+microsoft
+mimalloc
+mnt
+msc
+multidisplay
+multirealm
+musl
+myscope
+nVidia
+namespace
+namespaced
+namespacing
+nbd
+nemo
+netboot
+netdataNoBootstrap
+nftables
+nmu
+nodejs
+ntp
+ntpd
+ntpdate
+nusolve
+nvcc
+nvidia
+nvram
+nvtop
+octorate
+ok
+omplete
+onfig
+ons
+oomd
+openconnect
+openpgp
+openssh
+opentsdb
+os
+osx
+pagecount
+paris
+pasckiosk
+passwd
+pcengine
+pdf
+petitradtrans
+phd
+phonebook
+photoscan
+php
+pia
+pipenv
+pipx
+png
+podman
+powershell
+ppa
+ppk
+pre
+preconfigured
+prem
+prepended
+preseeding
+proc
+procmail
+procmailrc
+programmatically
+ps
+pscp
+psitop
+psu
+puppeting
+puttyrdprdr
+py
+pycharm
+pyenv
+pytorch
+pyxplot
+qgis
+rc
+rclone
+rda
+rdesktop
+rdp
+reactively
+readme
+rebase
+rebasing
+recentchanges
+recoded
+regedit
+rememberable
+remoteApp
+remoteapp
+remoteoeffnen
+renderMathInElement
+renice
+reniced
+repo
+reproducibly
+restic
+riotx
+rle
+rsa
+rsvc
+rsync
+rtf
+rtklib
+rxvt
+sFTP
+sata
+sbin
+scalable
+scanbus
+scp
+scsi
+sda
+sdl
+sed
+setserial
+sftp
+shorthands
+shotcut
+sid
+sigil
+signin
+signup
+smb
+smbclient
+smbgate
+sogo
+spamfilter
+speicherort
+sprintdoc
+ssd
+sshd
+sshfs
+sshuttle
+stackoverflow
+stellarium
+suEXEC
+suEXEC's
+suExec
+subdirectories
+subdirectory
+subfolder
+subfolders
+subuid
+sudo
+suexec
+supermongo
+svg
+svn
+swapon
+swarp
+symlink
+symlinks
+sysctl
+syslog
+systemd
+systray
+teamviewer
+telinit
+terminalserver
+tesseract
+tftp
+tftpd
+thunderbird
+timespan
+tmail
+tmp
+tmpfs
+tmux
+tokenization
+toolchain
+tooltips
+totp
+trelawney
+tts
+tty
+ttyS
+txt
+uber
+ubuntu
+udev
+udunits
+ufw
+uid
+uids
+umounted
+uncheck
+und
+underdimensioned
+une
+unencrypted
+unicode
+unicodeit
+unix
+unmanaged
+unmount
+unpaper
+unselect
+untracked
+untrusted
+url
+urxvt
+usb
+userParameters
+userdir
+userparameters
+userprofile
+userspace
+util
+uxterm
+vCalendar
+vcs
+vectorize
+venv
+venvs
+verschieben
+vimrc
+virtualenv
+vmstat
+vpn
+vvv
+wds
+webhook
+webhooks
+webmail
+webshare
+webshares
+webvpn
+weechat
+whitebophir
+wifi
+windowsws
+worktree
+writability
+wsgi
+www
+wxWidgets
+xen
+xfig
+xfree
+xfreerdp
+xhost
+xmgr
+xorg
+xrdp
+xvda
+xymon
+xyz
+yaml
+zRAM
+zfp
+zram
+zswap
+zu
diff --git a/README.markdown b/README.markdown
index 1e071158..7006ac55 100644
--- a/README.markdown
+++ b/README.markdown
@@ -2,3 +2,21 @@ ISG D-PHYS IT Documentation
 ===========================
 
 This is the source of our documentation at [readme.phys.ethz.ch](https://readme.phys.ethz.ch).
+
+
+Spellchecking
+-------------
+
+One can use `aspell` in markdown mode to check the spelling of all files. We add non-standard words in a personal dictionary `.dict.spl` to complement the default word list.
+
+Run non-interactively to list possible spelling mistakes.
+
+```sh
+find . -name '*.markdown' -exec sh -c 'aspell list --mode=markdown --personal="$PWD"/.dict.spl < {}' \;
+```
+
+Use interactive mode to take actions on spelling mistakes.
+
+```sh
+find . -name '*.markdown' -exec aspell check -x --mode=markdown --personal="$PWD"/.dict.spl {} \;
+```
-- 
GitLab