跳转到主要内容

System tips

Here, I describe basic tips to configure and manage systems, mostly from the console.

The console tips

There are some utility programs to help your console activities.

package popcon size description
mc @-@popcon1@-@ @-@psize1@-@ See ???
bsdutils @-@popcon1@-@ @-@psize1@-@ script(1) command to make a record of terminal session
screen @-@popcon1@-@ @-@psize1@-@ terminal multiplexer with VT100/ANSI terminal emulation
tmux @-@popcon1@-@ @-@psize1@-@ terminal multiplexer alternative (Use "Control-B" instead)
ripgrep @-@popcon1@-@ @-@psize1@-@ fast recursive string search in the source code tree with automatic filtering
fzf @-@popcon1@-@ @-@psize1@-@ fuzzy text finder
fzy @-@popcon1@-@ @-@psize1@-@ fuzzy text finder
rlwrap @-@popcon1@-@ @-@psize1@-@ readline feature command line wrapper
ledit @-@popcon1@-@ @-@psize1@-@ readline feature command line wrapper
rlfe @-@popcon1@-@ @-@psize1@-@ readline feature command line wrapper

List of programs to support console activities

Recording the shell activities cleanly

The simple use of script(1) (see ???) to record shell activity produces a file with control characters. This can be avoided by using col(1) as the following.

$ script
Script started, file is typescript

Do whatever … and press Ctrl-D to exit script.

$ col -bx < typescript > cleanedfile
$ vim cleanedfile

There are alternative methods to record the shell activities:

  • Use tee (usable during the boot process in the initramfs):

    $ sh -i 2>&1 | tee typescript
    
  • Use gnome-terminal with the extend line buffer for scrollback.

  • Use screen with "^A H" (see The screen program) to perform recording of console.

  • Use vim with ":terminal" to enter the terminal mode. Use "Ctrl-W N" to exit from terminal mode to normal mode. Use ":w typescript" to write the buffer to a file.

  • Use emacs with "M-x shell", "M-x eshell", or "M-x term" to enter recording console. Use "C-x C-w" to write the buffer to a file.

The screen program

screen(1) not only allows one terminal window to work with multiple processes, but also allows remote shell process to survive interrupted connections. Here is a typical use scenario of screen(1).

  1. You login to a remote machine.

  2. You start screen on a single console.

  3. You execute multiple programs in screen windows created with ^A c ("Control-A" followed by "c").

  4. You switch among the multiple screen windows by ^A n ("Control-A" followed by "n").

  5. Suddenly you need to leave your terminal, but you don't want to lose your active work by keeping the connection.

  6. You may detach the screen session by any methods.

    • Brutally unplug your network connection

    • Type ^A d ("Control-A" followed by "d") and manually logging out from the remote connection

    • Type ^A DD ("Control-A" followed by "DD") to have screen detach and log you out

  7. You log in again to the same remote machine (even from a different terminal).

  8. You start screen as "screen -r".

  9. screen magically reattaches all previous screen windows with all actively running programs.

[!TIP] You can save connection fees with screen for metered network connections such as dial-up and packet ones, because you can leave a process active while disconnected, and then re-attach it later when you connect again.

In a screen session, all keyboard inputs are sent to your current window except for the command keystroke. All screen command keystrokes are entered by typing ^A ("Control-A") plus a single key [plus any parameters]. Here are important ones to remember.

key binding meaning
^A ? show a help screen (display key bindings)
^A c create a new window and switch to it
^A n go to next window
^A p go to previous window
^A 0 go to window number 0
^A 1 go to window number 1
^A w show a list of windows
^A a send a Ctrl-A to current window as keyboard input
^A h write a hardcopy of current window to file
^A H begin/end logging current window to file
^A ^X lock the terminal (password protected)
^A d detach screen session from the terminal
^A DD detach screen session and log out

List of key bindings for screen

See screen(1) for details.

See tmux(1) for functionalities of the alternative command.

Navigating around directories

In ???, 2 tips to allow quick navigation around directories are described: $CDPATH and mc.

If you use fuzzy text filter program, you can do without typing the exact path. For fzf, include following in ~/.bashrc.

FZF_KEYBINDINGS_PATH=/usr/share/doc/fzf/examples/key-bindings.bash
FZF_COMPLETION_PATH=/usr/share/doc/fzf/examples/completion.bash
if [ -f $FZF_KEYBINDINGS_PATH ] && [ -f $FZF_COMPLETION_PATH ]; then
  . $FZF_KEYBINDINGS_PATH
  . $FZF_COMPLETION_PATH
fi

For example:

  • You can jump to a very deep subdirectory with minimal efforts. You first type "cd **" and press Tab. Then you will be prompted with candidate paths. Typing in partial path strings, e.g., s/d/b foo, will narrow down candidate paths. You select the path to be used by cd with cursor and return keys.

  • You can select a command from the command history more efficiently with minimal efforts. You press Ctrl-R at the command prompt. Then you will be prompted with candidate commands. Typing in partial command strings, e.g., vim d, will narrow down candidates. You select the one to be used with cursor and return keys.

Readline wrapper

Some commands such as /usr/bin/dash which lacks command line history editing capability can add such functionality transparently by running under rlwrap or its equivalents.

 $ rlwrap dash -i

This provides convenient platform to test subtle points for dash with friendly bash-like environment.

Scanning the source code tree

The rg(1) command in the ripgrep package offers a faster alternative to the grep(1) command for scanning the source code tree for typical situation. It takes advantage of modern multi-core CPUs and automatically applies reasonable filters to skip some files.

Customizing vim

After you learn basics of vim(1) through ???, please read Bram Moolenaar's "Seven habits of effective text editing (2000)" to understand how vim should be used.

Customizing vim with internal features

The behavior of vim can be changed significantly by enabling its internal features through the Ex-mode commands such as "set ..." to set vim options.

These Ex-mode commands can be included in user's vimrc file, traditional "~/.vimrc" or git-friendly "~/.vim/vimrc". Here is a very simple example [^1]:

""" Generic baseline Vim and Neovim configuration (~/.vimrc)
"""   - For NeoVim, use "nvim -u ~/.vimrc [filename]"
"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
let mapleader = ' '             " :h mapleader
""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
set nocompatible                " :h 'cp -- sensible (n)vim mode
syntax on                       " :h :syn-on
filetype plugin indent on       " :h :filetype-overview
set encoding=utf-8              " :h 'enc (default: latin1) -- sensible encoding
""" current vim option value can be verified by :set encoding?
set backspace=indent,eol,start  " :h 'bs (default: nobs) -- sensible BS
set statusline=%<%f%m%r%h%w%=%y[U+%04B]%2l/%2L=%P,%2c%V
set listchars=eol:¶,tab:⇄\ ,extends:↦,precedes:↤,nbsp:␣
set viminfo=!,'100,<5000,s100,h " :h 'vi -- bigger copy buffer etc.
""" Pick "colorscheme" from blue darkblue default delek desert elflord evening
""" habamax industry koehler lunaperche morning murphy pablo peachpuff quiet ron
""" shine slate torte zellner
colorscheme industry
""" don't pick "colorscheme" as "default" which may kill SpellUnderline settings
set scrolloff=5                 " :h 'scr -- show 5 lines around cursor
set laststatus=2                " :h 'ls (default 1)  k
""" boolean options can be unset by prefixing "no"
set ignorecase                  " :h 'ic
set smartcase                   " :h 'scs
set autoindent                  " :h 'ai
set smartindent                 " :h 'si
set nowrap                      " :h 'wrap
"set list                        " :h 'list (default nolist)
set noerrorbells                " :h 'eb
set novisualbell                " :h 'vb
set t_vb=                       " :h 't_vb -- termcap visual bell
set spell                       " :h 'spell
set spelllang=en_us,cjk         " :h 'spl -- english spell, ignore CJK
set clipboard=unnamedplus       " :h 'cb -- cut/copy/paste with other app
set hidden                      " :h 'hid
set autowrite                   " :h 'aw
set timeoutlen=300              " :h 'tm

The keymap of vim can be changed in user's vimrc file. E.g.:

[!CAUTION] Don't try to change the default key bindings without very good reasons.

In order for the above keybindings to function properly, the terminal program needs to be configured to generate "ASCII DEL" for Backspace-key and "Escape sequence" for Delete-key.

Other miscellaneous configuration can be changed in user's vimrc file. E.g.:

""" Use faster 'rg' (ripgrep package) for :grep
if executable("rg")
  set grepprg=rg\ --vimgrep\ --smart-case
  set grepformat=%f:%l:%c:%m
endif
""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
""" Retain last cursor position :h '"
augroup RetainLastCursorPosition
  autocmd!
  autocmd BufReadPost *
    \ if line("'\"") > 0 && line ("'\"") <= line("$") |
    \   exe "normal! g'\"" |
    \ endif
augroup END
""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
""" Force to use underline for spell check results
augroup SpellUnderline
  autocmd!
  autocmd ColorScheme * highlight SpellBad term=Underline gui=Undercurl
  autocmd ColorScheme * highlight SpellCap term=Underline gui=Undercurl
  autocmd ColorScheme * highlight SpellLocal term=Underline gui=Undercurl
  autocmd ColorScheme * highlight SpellRare term=Underline gui=Undercurl
augroup END
""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
""" highlight tailing spaces except when typing as red (set after colorscheme)
highlight TailingWhitespaces ctermbg=red guibg=red
""" \s\+     1 or more whitespace character: <Space> and <Tab>
""" \%#\@<!  Matches with zero width if the cursor position does NOT match.
match TailingWhitespaces /\s\+\%#\@<!$/

Customizing vim with external packages

Interesting external plugin packages can be found:

Plugin packages in the vim-scripts package can be enabled using user's vimrc file. E.g.:

packadd! secure-modelines
packadd! winmanager
" IDE-like UI for files and buffers with <space>w
nnoremap <leader>w         :WMToggle<CR>

The new native Vim package system works nicely with "git" and "git submodule". One such example configuration can be found at my git repository: dot-vim. This does essentially:

  • By using "git" and "git submodule", latest external packages, such as "name", are placed into ~/.vim/pack/*/opt/name and similar.

  • By adding :packadd! name line to user's vimrc file, these packages are placed on runtimepath.

  • Vim loads these packages on runtimepath during its initialization.

  • At the end of its initialization, tags for the installed documents are updated with "helptags ALL".

For more, please start vim with "vim --startuptime vimstart.log" to check actual execution sequence and time spent for each step.

It is quite confusing to see too many ways[^2] to manage and load these external packages to vim. Checking the original information is the best cure.

key strokes information
:help package explanation on the vim package mechanism
:help runtimepath explanation on the runtimepath mechanism
:version internal states including candidates for the vimrc file
:echo $VIM the environment variable "$VIM" used to locate the vimrc file
:set runtimepath? list of directories which will be searched for all runtime support files
:echo $VIMRUNTIME the environment variable "$VIMRUNTIME" used to locate various system provided runtime support files

Information on the initialization of vim

Data recording and presentation

The log daemon

Many traditional programs record their activities in the text file format under the "/var/log/" directory.

logrotate(8) is used to simplify the administration of log files on a system which generates a lot of log files.

Many new programs record their activities in the binary file format using systemd-journald(8) Journal service under the "/var/log/journal" directory.

You can log data to the systemd-journald(8) Journal from a shell script by using the systemd-cat(1) command.

See ??? and ???.

Log analyzer

Here are notable log analyzers ("~Gsecurity::log-analyzer" in aptitude(8)).

package popcon size description
fail2ban @-@popcon1@-@ @-@psize1@-@ ban IPs that cause multiple authentication errors
logwatch @-@popcon1@-@ @-@psize1@-@ log analyzer with nice output written in Perl
awstats @-@popcon1@-@ @-@psize1@-@ powerful and featureful web server log analyzer
analog @-@popcon1@-@ @-@psize1@-@ web server log analyzer
sarg @-@popcon1@-@ @-@psize1@-@ squid analysis report generator
pflogsumm @-@popcon1@-@ @-@psize1@-@ Postfix log entry summarizer
fwlogwatch @-@popcon1@-@ @-@psize1@-@ firewall log analyzer
squidview @-@popcon1@-@ @-@psize1@-@ monitor and analyze squid access.log files
swatch @-@popcon1@-@ @-@psize1@-@ log file viewer with regexp matching, highlighting, and hooks
crm114 @-@popcon1@-@ @-@psize1@-@ Controllable Regex Mutilator and Spam Filter (CRM114)
icmpinfo @-@popcon1@-@ @-@psize1@-@ interpret ICMP messages

List of system log analyzers

[!NOTE] CRM114 provides language infrastructure to write fuzzy filters with the TRE regex library. Its popular use is spam mail filter but it can be used as log analyzer.

Customized display of text data

Although pager tools such as more(1) and less(1) (see ???) and custom tools for highlighting and formatting (see ???) can display text data nicely, general purpose editors (see ???) are most versatile and customizable.

[!TIP] For vim(1) and its pager mode alias view(1), ":set hls" enables highlighted search.

Customized display of time and date

The default display format of time and date by the "ls -l" command depends on the locale (see ??? for value). The "$LANG" variable is referred first and it can be overridden by the "$LC_TIME" or "$LC_ALL" exported environment variables.

The actual default display format for each locale depends on the version of the standard C library (the libc6 package) used. I.e., different releases of Debian had different defaults. For iso-formats, see ISO 8601.

If you really wish to customize this display format of time and date beyond the locale, you should set the time style value by the "--time-style" argument or by the "$TIME_STYLE" value (see ls(1), date(1), "info coreutils 'ls invocation'").

time style value locale display of time and date
iso any 01-19 00:15
long-iso any 2009-01-19 00:15
full-iso any 2009-01-19 00:15:16.000000000 +0900
locale C Jan 19 00:15
locale en_US.UTF-8 Jan 19 00:15
locale es_ES.UTF-8 ene 19 00:15
+%d.%m.%y %H:%M any 19.01.09 00:15
+%d.%b.%y %H:%M C or en_US.UTF-8 19.Jan.09 00:15
+%d.%b.%y %H:%M es_ES.UTF-8 19.ene.09 00:15

Display examples of time and date for the "ls -l" command with the time style value

[!TIP] You can eliminate typing long option on commandline using command alias (see ???):

alias ls='ls --time-style=+%d.%m.%y %H:%M'

Colorized shell echo

Shell echo to most modern terminals can be colorized using ANSI escape code (see "/usr/share/doc/xterm/ctlseqs.txt.gz").

For example, try the following

$ RED=$(printf "\x1b[31m")
$ NORMAL=$(printf "\x1b[0m")
$ REVERSE=$(printf "\x1b[7m")
$ echo "${RED}RED-TEXT${NORMAL} ${REVERSE}REVERSE-TEXT${NORMAL}"

Colorized commands

Colorized commands are handy for inspecting their output in the interactive environment. I include the following in my "~/.bashrc".

if [ "$TERM" != "dumb" ]; then
    eval "`dircolors -b`"
    alias ls='ls --color=always'
    alias ll='ls --color=always -l'
    alias la='ls --color=always -A'
    alias less='less -R'
    alias ls='ls --color=always'
    alias grep='grep --color=always'
    alias egrep='egrep --color=always'
    alias fgrep='fgrep --color=always'
    alias zgrep='zgrep --color=always'
else
    alias ll='ls -l'
    alias la='ls -A'
fi

The use of alias limits color effects to the interactive command usage. It has advantage over exporting environment variable "export GREP_OPTIONS='--color=auto'" since color can be seen under pager programs such as less(1). If you wish to suppress color when piping to other programs, use "--color=auto" instead in the above example for "~/.bashrc".

[!TIP] You can turn off these colorizing aliases in the interactive environment by invoking shell with "TERM=dumb bash".

Recording the editor activities for complex repeats

You can record the editor activities for complex repeats.

For Vim, as follows.

  • "qa": start recording typed characters into named register "a".

  • … editor activities

  • "q": end recording typed characters.

  • "@a": execute the contents of register "a".

For Emacs, as follows.

  • "C-x (": start defining a keyboard macro.

  • … editor activities

  • "C-x )": end defining a keyboard macro.

  • "C-x e": execute a keyboard macro.

Recording the graphics image of an X application

There are few ways to record the graphics image of an X application, including an xterm display.

package popcon size screen command
gnome-screenshot @-@popcon1@-@ @-@psize1@-@ Wayland screenshot application for GNOME
flameshot @-@popcon1@-@ @-@psize1@-@ Wayland screenshot application on steroid
gimp @-@popcon1@-@ @-@psize1@-@ Wayland + X screenshot in GUI menu
x11-apps @-@popcon1@-@ @-@psize1@-@ X xwd(1)
imagemagick @-@popcon1@-@ @-@psize1@-@ X import(1)
scrot @-@popcon1@-@ @-@psize1@-@ X scrot(1)

List of graphics image manipulation tools

Recording changes in configuration files

There are specialized tools to record changes in configuration files with help of DVCS and to make system snapshots on Btrfs.

package popcon size description
etckeeper @-@popcon1@-@ @-@psize1@-@ store configuration files and their metadata with Git (default), Mercurial, or GNU Bazaar
timeshift @-@popcon1@-@ @-@psize1@-@ system restore utility using rsync or BTRFS snapshots
snapper @-@popcon1@-@ @-@psize1@-@ Linux filesystem snapshot management tool

List of packages which can record configuration history

You may also think about local script ??? approach.

Monitoring, controlling, and starting program activities

Program activities can be monitored and controlled using specialized tools.

package popcon size description
coreutils @-@popcon1@-@ @-@psize1@-@ nice(1): run a program with modified scheduling priority
bsdutils @-@popcon1@-@ @-@psize1@-@ renice(1): modify the scheduling priority of a running process
procps @-@popcon1@-@ @-@psize1@-@ "/proc" filesystem utilities: ps(1), top(1), kill(1), watch(1), …
psmisc @-@popcon1@-@ @-@psize1@-@ "/proc" filesystem utilities: killall(1), fuser(1), peekfd(1), pstree(1)
time @-@popcon1@-@ @-@psize1@-@ time(1): run a program to report system resource usages with respect to time
sysstat @-@popcon1@-@ @-@psize1@-@ sar(1), iostat(1), mpstat(1), …: system performance tools for Linux
isag @-@popcon1@-@ @-@psize1@-@ Interactive System Activity Grapher for sysstat
lsof @-@popcon1@-@ @-@psize1@-@ lsof(8): list files opened by a running process using "-p" option
strace @-@popcon1@-@ @-@psize1@-@ strace(1): trace system calls and signals
ltrace @-@popcon1@-@ @-@psize1@-@ ltrace(1): trace library calls
xtrace @-@popcon1@-@ @-@psize1@-@ xtrace(1): trace communication between X11 client and server
powertop @-@popcon1@-@ @-@psize1@-@ powertop(1): information about system power use
cron @-@popcon1@-@ @-@psize1@-@ run processes according to a schedule in background from cron(8) daemon
anacron @-@popcon1@-@ @-@psize1@-@ cron-like command scheduler for systems that don't run 24 hours a day
at @-@popcon1@-@ @-@psize1@-@ at(1) or batch(1): run a job at a specified time or below certain load level

List of tools for monitoring and controlling program activities

[!TIP] The procps packages provide very basics of monitoring, controlling, and starting program activities. You should learn all of them.

Timing a process

Display time used by the process invoked by the command.

# time some_command >/dev/null
real    0m0.035s       # time on wall clock (elapsed real time)
user    0m0.000s       # time in user mode
sys     0m0.020s       # time in kernel mode

The scheduling priority

A nice value is used to control the scheduling priority for the process.

nice value scheduling priority
19 lowest priority process (nice)
0 very high priority process for user
-20 very high priority process for root (not-nice)

List of nice values for the scheduling priority

# nice  -19 top                                      # very nice
# nice --20 wodim -v -eject speed=2 dev=0,0 disk.img # very fast

Sometimes an extreme nice value does more harm than good to the system. Use this command carefully.

The ps command

The ps(1) command on a Debian system support both BSD and SystemV features and helps to identify the process activity statically.

style typical command feature
BSD ps aux display %CPU %MEM
System V ps -efH display PPID

List of ps command styles

For the zombie (defunct) children process, you can kill them by the parent process ID identified in the "PPID" field.

The pstree(1) command display a tree of processes.

The top command

top(1) on the Debian system has rich features and helps to identify what process is acting funny dynamically.

It is an interactive full screen program. You can get its usage help press by pressing the "h"-key and terminate it by pressing the "q"-key.

Listing files opened by a process

You can list all files opened by a process with a process ID (PID), e.g. 1, by the following.

$ sudo lsof -p 1

PID=1 is usually the init program.

Tracing program activities

You can trace program activity with strace(1), ltrace(1), or xtrace(1) for system calls and signals, library calls, or communication between X11 client and server.

You can trace system calls of the ls command as the following.

$ sudo strace ls

[!TIP] Use strace-graph script found in /usr/share/doc/strace/examples/ to make a nice tree view

Identification of processes using files or sockets

You can also identify processes using files by fuser(1), e.g. for "/var/log/mail.log" by the following.

$ sudo fuser -v /var/log/mail.log
                     USER        PID ACCESS COMMAND
/var/log/mail.log:   root       2946 F.... rsyslogd

You see that file "/var/log/mail.log" is open for writing by the rsyslogd(8) command.

You can also identify processes using sockets by fuser(1), e.g. for "smtp/tcp" by the following.

$ sudo fuser -v smtp/tcp
                     USER        PID ACCESS COMMAND
smtp/tcp:            Debian-exim   3379 F.... exim4

Now you know your system runs exim4(8) to handle TCP connections to SMTP port (25).

Repeating a command with a constant interval

watch(1) executes a program repeatedly with a constant interval while showing its output in fullscreen.

$ watch w

This displays who is logged on to the system updated every 2 seconds.

Repeating a command looping over files

There are several ways to repeat a command looping over files matching some condition, e.g. matching glob pattern "*.ext".

  • Shell for-loop method (see ???):
for x in *.ext; do if [ -f "$x"]; then command "$x" ; fi; done
  • find(1) and xargs(1) combination:
find . -type f -maxdepth 1 -name '*.ext' -print0 | xargs -0 -n 1 command
  • find(1) with "-exec" option with a command:
find . -type f -maxdepth 1 -name '*.ext' -exec command '{}' \;
  • find(1) with "-exec" option with a short shell script:
find . -type f -maxdepth 1 -name '*.ext' -exec sh -c "command '{}' && echo 'successful'" \;

The above examples are written to ensure proper handling of funny file names such as ones containing spaces. See ??? for more advance uses of find(1).

Starting a program from GUI

For the command-line interface (CLI), the first program with the matching name found in the directories specified in the $PATH environment variable is executed. See ???.

For the graphical user interface (GUI) compliant to the freedesktop.org standards, the *.desktop files in the /usr/share/applications/ directory provide necessary attributes for the GUI menu display of each program. Each package which is compliant to Freedesktop.org's xdg menu system installs its menu data provided by "*.desktop" under "/usr/share/applications/". Modern desktop environments which are compliant to Freedesktop.org standard use these data to generate their menu using the xdg-utils package. See "/usr/share/doc/xdg-utils/README".

For example, the chromium.desktop file defines attributes for the "Chromium Web Browser" such as "Name" for the program name, "Exec" for the program execution path and arguments, "Icon" for the icon used, etc. (see the Desktop Entry Specification) as follows:

[Desktop Entry]
Version=1.0
Name=Chromium Web Browser
GenericName=Web Browser
Comment=Access the Internet
Comment[fr]=Explorer le Web
Exec=/usr/bin/chromium %U
Terminal=false
X-MultipleArgs=false
Type=Application
Icon=chromium
Categories=Network;WebBrowser;
MimeType=text/html;text/xml;application/xhtml_xml;x-scheme-handler/http;x-scheme-handler/https;
StartupWMClass=Chromium
StartupNotify=true

This is an oversimplified description. The *.desktop files are scanned as follows.

The desktop environment sets $XDG_DATA_HOME and $XDG_DATA_DIR environment variables. For example, under the GNOME:

  • $XDG_DATA_HOME is unset. (The default value of $HOME/.local/share is used.)

  • $XDG_DATA_DIRS is set to /usr/share/gnome:/usr/local/share/:/usr/share/.

So the base directories (see XDG Base Directory Specification) and the applications directories are as follows.

  • $HOME/.local/share/ → $HOME/.local/share/applications/

  • /usr/share/gnome/ → /usr/share/gnome/applications/

  • /usr/local/share/ → /usr/local/share/applications/

  • /usr/share/ → /usr/share/applications/

The *.desktop files are scanned in these applications directories in this order.

[!TIP] A user custom GUI menu entry can be created by adding a *.desktop file in the $HOME/.local/share/applications/ directory.

[!TIP] The "Exec=..." line isn't parsed by the shell. Use the env(1) command if environment variables need to be set.

[!TIP] Similarly, if a *.desktop file is created in the autostart directory under these base directories, the specified program in the *.desktop file is executed automatically when the desktop environment is started. See Desktop Application Autostart Specification.

[!TIP] Similarly, if a *.desktop file is created in the $HOME/Desktop directory and the Desktop environment is configured to support the desktop icon launcher feature, the specified program in it is executed upon clicking the icon. Please note that the actual name of the $HOME/Desktop directory is locale dependent. See xdg-user-dirs-update(1).

Customizing program to be started

Some programs start another program automatically. Here are check points for customizing this process.

  • Application configuration menu:

    • GNOME desktop: "Settings" → "Apps" → "Default Apps"

    • KDE desktop: "Application Launcher" → "System Settings" → "Default Applications"

    • Iceweasel browser: "Edit" → "Preferences" → "Applications"

    • mc(1): "/etc/mc/mc.ext"

  • Environment variables such as "$BROWSER", "$EDITOR", "$VISUAL", and "$PAGER" (see environ(7))

  • The update-alternatives(1) system for programs such as "editor", "view", "x-www-browser", "gnome-www-browser", and "www-browser" (see ???)

  • the "~/.mailcap" and "/etc/mailcap" file contents which associate MIME type with program (see mailcap(5))

  • The "~/.mime.types" and "/etc/mime.types" file contents which associate file name extension with MIME type (see run-mailcap(1))

[!TIP] update-mime(8) updates the "/etc/mailcap" file using "/etc/mailcap.order" file (see mailcap.order(5)).

[!TIP] The debianutils package provides sensible-browser(1), sensible-editor(1), and sensible-pager(1) which make sensible decisions on which editor, pager, and web browser to call, respectively. I recommend you to read these shell scripts.

[!TIP] In order to run a console application such as mutt under GUI as your preferred application, you should create an GUI application as following and set "/usr/local/bin/mutt-term" as your preferred application to be started as described.

# cat /usr/local/bin/mutt-term <<EOF
#!/bin/sh
gnome-terminal -e "mutt \$@"
EOF
# chmod 755 /usr/local/bin/mutt-term

Killing a process

Use kill(1) to kill (or send a signal to) a process by the process ID.

Use killall(1) or pkill(1) to do the same by the process command name and other attributes.

signal value signal name action note
0 --- no signal is sent (see kill(2)) check if process is running
1 SIGHUP terminate the process disconnected terminal (signal hang up)
2 SIGINT terminate the process interrupt from keyboard (CTRL-C)
3 SIGQUIT terminate the process and dump core quit from keyboard (CTRL-\)
9 SIGKILL terminate the process unblockable kill signal
15 SIGTERM terminate the process blockable termination signal

List of frequently used signals for kill command

Scheduling tasks once

Run the at(1) command to schedule a one-time job by the following.

$ echo 'command -args'| at 3:40 monday

Scheduling tasks regularly

Use cron(8) to schedule tasks regularly. See crontab(1) and crontab(5).

You can schedule to run processes as a normal user, e.g. foo by creating a crontab(5) file as "/var/spool/cron/crontabs/foo" with "crontab -e" command.

Here is an example of a crontab(5) file.

# use /usr/bin/sh to run commands, no matter what /etc/passwd says
SHELL=/bin/sh
# mail any output to paul, no matter whose crontab this is
MAILTO=paul
# Min Hour DayOfMonth Month DayOfWeek command (Day... are OR'ed)
# run at 00:05, every day
5  0  *  * *   $HOME/bin/daily.job >> $HOME/tmp/out 2>&1
# run at 14:15 on the first of every month -- output mailed to paul
15 14 1  * *   $HOME/bin/monthly
# run at 22:00 on weekdays(1-5), annoy Joe. % for newline, last % for cc:
0 22 *   * 1-5 mail -s "It's 10pm" joe%Joe,%%Where are your kids?%.%%
23 */2 1 2 *   echo "run 23 minutes after 0am, 2am, 4am ..., on Feb 1"
5  4 *   * sun echo "run at 04:05 every Sunday"
# run at 03:40 on the first Monday of each month
40 3 1-7 * *   [ "$(date +%a)" == "Mon" ] && command -args

[!TIP] For the system not running continuously, install the anacron package to schedule periodic commands at the specified intervals as closely as machine-uptime permits. See anacron(8) and anacrontab(5).

[!TIP] For scheduled system maintenance scripts, you can run them periodically from root account by placing such scripts in "/etc/cron.hourly/", "/etc/cron.daily/", "/etc/cron.weekly/", or "/etc/cron.monthly/". Execution timings of these scripts can be customized by "/etc/crontab" and "/etc/anacrontab".

Systemd has low level capability to schedule programs to run without cron daemon. For example, /lib/systemd/system/apt-daily.timer and /lib/systemd/system/apt-daily.service set up daily apt download activities. See systemd.timer(5) .

Scheduling tasks on event

Systemd can schedule program not only on the timer event but also on the mount event. See ??? and ??? for examples.

Alt-SysRq key

Pressing Alt-SysRq (PrtScr) followed by one keys does the magic of rescuing control of the system.

key following Alt-SysRq description of action
k kill all processes on the current virtual console (SAK)
s sync all mounted filesystems to avoid data corruption
u remount all mounted filesystems read-only (umount)
r restore the keyboard from raw mode after X crashes

List of notable SAK command keys

See more on Linux kernel user’s and administrator’s guide » Linux Magic System Request Key Hacks

[!TIP] From SSH terminal etc., you can use the Alt-SysRq feature by writing to the "/proc/sysrq-trigger". For example, "echo s > /proc/sysrq-trigger; echo u > /proc/sysrq-trigger" from the root shell prompt syncs and umounts all mounted filesystems.

The current (2021) Debian amd64 Linux kernel has /proc/sys/kernel/sysrq=438=0b110110110:

  • 2 = 0x2 - enable control of console logging level (ON)

  • 4 = 0x4 - enable control of keyboard (SAK, unraw) (ON)

  • 8 = 0x8 - enable debugging dumps of processes etc. (OFF)

  • 16 = 0x10 - enable sync command (ON)

  • 32 = 0x20 - enable remount read-only (ON)

  • 64 = 0x40 - enable signaling of processes (term, kill, oom-kill) (OFF)

  • 128 = 0x80 - allow reboot/poweroff (ON)

  • 256 = 0x100 - allow nicing of all RT tasks (ON)

System maintenance tips

Who is on the system?

You can check who is on the system by the following.

  • who(1) shows who is logged on.

  • w(1) shows who is logged on and what they are doing.

  • last(1) shows listing of last logged in user.

  • lastb(1) shows listing of last bad logged in users.

[!TIP] "/var/run/utmp", and "/var/log/wtmp" hold such user information. See login(1) and utmp(5).

Warning everyone

You can send message to everyone who is logged on to the system with wall(1) by the following.

$ echo "We are shutting down in 1 hour" | wall

Hardware identification

For the PCI-like devices (AGP, PCI-Express, CardBus, ExpressCard, etc.), lspci(8) (probably with "-nn" option) is a good start for the hardware identification.

Alternatively, you can identify the hardware by reading contents of "/proc/bus/pci/devices" or browsing directory tree under "/sys/bus/pci" (see ???).

package popcon size description
pciutils @-@popcon1@-@ @-@psize1@-@ Linux PCI Utilities: lspci(8)
usbutils @-@popcon1@-@ @-@psize1@-@ Linux USB utilities: lsusb(8)
nvme-cli @-@popcon1@-@ @-@psize1@-@ NVMe utilities for Linux: nvme(1)
pcmciautils @-@popcon1@-@ @-@psize1@-@ PCMCIA utilities for Linux: pccardctl(8)
scsitools @-@popcon1@-@ @-@psize1@-@ collection of tools for SCSI hardware management: lsscsi(8)
procinfo @-@popcon1@-@ @-@psize1@-@ system information obtained from "/proc": lsdev(8)
lshw @-@popcon1@-@ @-@psize1@-@ information about hardware configuration: lshw(1)
discover @-@popcon1@-@ @-@psize1@-@ hardware identification system: discover(8)

List of hardware identification tools

Hardware configuration

Although most of the hardware configuration on modern GUI desktop systems such as GNOME and KDE can be managed through accompanying GUI configuration tools, it is a good idea to know some basics methods to configure them.

For the keyboard and terminal configuration, see ??? and ???.

package popcon size description
console-setup @-@popcon1@-@ @-@psize1@-@ Linux console font and keytable utilities
keyd @-@popcon1@-@ @-@psize1@-@ keyboard key remapping daemon using kernel level input primitives (evdev, uinput)
keyd-application-mapper @-@popcon1@-@ @-@psize1@-@ keyboard key remapping daemon - application-specific remapper
x11-xserver-utils @-@popcon1@-@ @-@psize1@-@ X server utilities: xset(1), xmodmap(1)
acpid @-@popcon1@-@ @-@psize1@-@ daemon to manage events delivered by the Advanced Configuration and Power Interface (ACPI)
acpi @-@popcon1@-@ @-@psize1@-@ utility to display information on ACPI devices
sleepd @-@popcon1@-@ @-@psize1@-@ daemon to put a laptop to sleep during inactivity
hdparm @-@popcon1@-@ @-@psize1@-@ hard disk access optimization (see Optimization of hard disk)
smartmontools @-@popcon1@-@ @-@psize1@-@ control and monitor storage systems using S.M.A.R.T.
setserial @-@popcon1@-@ @-@psize1@-@ collection of tools for serial port management
memtest86+ @-@popcon1@-@ @-@psize1@-@ collection of tools for memory hardware management
scsitools @-@popcon1@-@ @-@psize1@-@ collection of tools for SCSI hardware management
setcd @-@popcon1@-@ @-@psize1@-@ compact disc drive access optimization
big-cursor @-@popcon1@-@ @-@psize1@-@ larger mouse cursors for X

List of hardware configuration tools

Here, ACPI is a newer framework for the power management system than APM.

[!TIP] CPU frequency scaling on modern system is governed by kernel modules such as acpi_cpufreq.

System and hardware time

The following sets system and hardware time to MM/DD hh:mm, CCYY.

# date MMDDhhmmCCYY
# hwclock --utc --systohc
# hwclock --show

Times are normally displayed in the local time on the Debian system but the hardware and system time usually use UTC(GMT).

If the hardware time is set to UTC, change the setting to "UTC=yes" in the "/etc/default/rcS".

The following reconfigure the timezone used by the Debian system.

# dpkg-reconfigure tzdata

If you wish to update system time via network, consider to use the NTP service with the packages such as ntp, ntpdate, and chrony.

[!TIP] Under systemd, use systemd-timesyncd for the network time synchronization instead. See systemd-timesyncd(8).

See the following.

[!TIP] ntptrace(8) in the ntp package can trace a chain of NTP servers back to the primary source.

The sound infrastructure

Device drivers for sound cards for current Linux are provided by Advanced Linux Sound Architecture (ALSA). ALSA provides emulation mode for previous Open Sound System (OSS) for compatibility.

Application software may be configured not only to access sound devices directly but also to access them via some standardized sound server system. Currently, PulseAudio, JACK, and PipeWire are used as sound server system. See Debian wiki page on Sound for the latest situation.

There is usually a common sound engine for each popular desktop environment. Each sound engine used by the application can choose to connect to different sound servers.

[!TIP] Use "cat /dev/urandom > /dev/audio" or speaker-test(1) to test speaker (^C to stop).

[!TIP] If you can not get sound, your speaker may be connected to a muted output. Modern sound system has many outputs. alsamixer(1) in the alsa-utils package is useful to configure volume and mute settings.

package popcon size description
alsa-utils @-@popcon1@-@ @-@psize1@-@ utilities for configuring and using ALSA
oss-compat @-@popcon1@-@ @-@psize1@-@ OSS compatibility under ALSA preventing "/dev/dsp not found" errors
pipewire @-@popcon1@-@ @-@psize1@-@ audio and video processing engine multimedia server - metapackage
pipewire-bin @-@popcon1@-@ @-@psize1@-@ audio and video processing engine multimedia server - audio server and CLI programs
pipewire-alsa @-@popcon1@-@ @-@psize1@-@ audio and video processing engine multimedia server - audio server to replace ALSA
pipewire-pulse @-@popcon1@-@ @-@psize1@-@ audio and video processing engine multimedia server - audio server to replace PulseAudio
pulseaudio @-@popcon1@-@ @-@psize1@-@ PulseAudio server
libpulse0 @-@popcon1@-@ @-@psize1@-@ PulseAudio client library
jackd @-@popcon1@-@ @-@psize1@-@ JACK Audio Connection Kit. (JACK) server (low latency)
libjack0 @-@popcon1@-@ @-@psize1@-@ JACK Audio Connection Kit. (JACK) library (low latency)
libphonon4qt5-4 @-@popcon1@-@ @-@psize1@-@ Phonon: KDE sound engine

List of sound packages

Disabling the screen saver

For disabling the screen saver, use following commands.

environment command
The Linux console setterm -powersave off
The X Window (turning off screensaver) xset s off
The X Window (disabling dpms) xset -dpms
The X Window (GUI configuration of screen saver) xscreensaver-command -prefs

List of commands for disabling the screen saver

Disabling beep sounds

One can always unplug the PC speaker to disable beep sounds. Removing pcspkr kernel module does this for you.

The following prevents the readline(3) program used by bash(1) to beep when encountering an alert character (ASCII=7).

$ echo "set bell-style none">> ~/.inputrc

Memory usage

There are 2 resources available for you to get the memory usage situation.

  • The kernel boot message in the "/var/log/dmesg" contains the total exact size of available memory.

  • free(1) and top(1) display information on memory resources on the running system.

Here is an example.

# grep '\] Memory' /var/log/dmesg
[    0.004000] Memory: 990528k/1016784k available (1975k kernel code, 25868k reserved, 931k data, 296k init)
$ free -k
             total       used       free     shared    buffers     cached
Mem:        997184     976928      20256          0     129592     171932
-/+ buffers/cache:     675404     321780
Swap:      4545576          4    4545572

You may be wondering "dmesg tells me a free of 990 MB, and free -k says 320 MB is free. More than 600 MB missing …".

Do not worry about the large size of "used" and the small size of "free" in the "Mem:" line, but read the one under them (675404 and 321780 in the example above) and relax.

For my MacBook with 1GB=1048576k DRAM (video system steals some of this), I see the following.

report size
Total size in dmesg 1016784k = 1GB - 31792k
Free in dmesg 990528k
Total under shell 997184k
Free under shell 20256k (but effectively 321780k)

List of memory sizes reported

System security and integrity check

Poor system maintenance may expose your system to external exploitation.

For system security and integrity check, you should start with the following.

package popcon size description
logcheck @-@popcon1@-@ @-@psize1@-@ daemon to mail anomalies in the system logfiles to the administrator
debsums @-@popcon1@-@ @-@psize1@-@ utility to verify installed package files against MD5 checksums
chkrootkit @-@popcon1@-@ @-@psize1@-@ rootkit detector
clamav @-@popcon1@-@ @-@psize1@-@ anti-virus utility for Unix - command-line interface
tiger @-@popcon1@-@ @-@psize1@-@ report system security vulnerabilities
tripwire @-@popcon1@-@ @-@psize1@-@ file and directory integrity checker
john @-@popcon1@-@ @-@psize1@-@ active password cracking tool
aide @-@popcon1@-@ @-@psize1@-@ Advanced Intrusion Detection Environment - static binary
integrit @-@popcon1@-@ @-@psize1@-@ file integrity verification program
crack @-@popcon1@-@ @-@psize1@-@ password guessing program

List of tools for system security and integrity check

Here is a simple script to check for typical world writable incorrect file permissions.

# find / -perm 777 -a \! -type s -a \! -type l -a \! \( -type d -a -perm 1777 \)

[!CAUTION] Since the debsums package uses MD5 checksums stored locally, it can not be fully trusted as the system security audit tool against malicious attacks.

Data storage tips

Booting your system as the Linux live system (see ??? and ???) makes it easy for you to reconfigure data storage on the installed system.

[!NOTE] Statements on hard disk (HDD) are applicable to other storage devices such as SSD / USB flash drive / Memory card / ... . Replace device names in examples such as /dev/sda with applicable device names /dev/nvme0, /dev/mmcblk0, ... .

You may need to umount(8) some devices manually from the command line before operating on them if they are automatically mounted by the GUI desktop system.

Disk space usage

The disk space usage can be evaluated by programs provided by the mount, coreutils, and xdu packages:

  • mount(8) reports all mounted filesystems (= disks).

  • df(1) reports the disk space usage for the file system.

  • du(1) reports the disk space usage for the directory tree.

[!TIP] You can feed the output of du(8) to xdu(1) to produce its graphical and interactive presentation with "du -k . |xdu", "sudo du -k -x / |xdu", etc.

Disk partition configuration

For disk partition configuration, although fdisk(8) has been considered standard, parted(8) deserves some attention. "Disk partitioning data", "partition table", "partition map", and "disk label" are all synonyms.

Older PCs use the classic Master Boot Record (MBR) scheme to hold disk partitioning data in the first sector, i.e., LBA sector 0 (512 bytes).

Recent PCs with Unified Extensible Firmware Interface (UEFI), including Intel-based Macs, use GUID Partition Table (GPT) scheme to hold disk partitioning data not in the first sector.

Although fdisk(8) has been standard for the disk partitioning tool, parted(8) is replacing it.

package popcon size description
util-linux @-@popcon1@-@ @-@psize1@-@ miscellaneous system utilities including fdisk(8) and cfdisk(8)
parted @-@popcon1@-@ @-@psize1@-@ GNU Parted disk partition resizing program
gparted @-@popcon1@-@ @-@psize1@-@ GNOME partition editor based on libparted
gdisk @-@popcon1@-@ @-@psize1@-@ partition editor for the GPT/MBR hybrid disk
kpartx @-@popcon1@-@ @-@psize1@-@ program to create device mappings for partitions

List of disk partition management packages

[!CAUTION] Although parted(8) claims to create and to resize filesystem too, it is safer to do such things using best maintained specialized tools such as mkfs(8) (mkfs.msdos(8), mkfs.ext2(8), mkfs.ext3(8), mkfs.ext4(8), …) and resize2fs(8).

[!NOTE] In order to switch between GPT and MBR, you need to erase first few blocks of disk contents directly (see Clearing file contents) and use "parted /dev/sdx mklabel gpt" or "parted /dev/sdx mklabel msdos" to set it. Please note "msdos" is use here for MBR.

Accessing partition using UUID

Although reconfiguration of your partition or activation order of removable storage media may yield different names for partitions, you can access them consistently. This is also helpful if you have multiple disks and your BIOS/UEFI doesn't give them consistent device names.

  • mount(8) with "-U" option can mount a block device using UUID, instead of using its file name such as "/dev/sda3".

  • "/etc/fstab" (see fstab(5)) can use UUID.

  • Boot loaders (???) may use UUID too.

[!TIP] You can probe UUID of a block special device with blkid(8).

You can also probe UUID and other information with "lsblk -f".

LVM2

LVM2 is a logical volume manager for the Linux kernel. With LVM2, disk partitions can be created on logical volumes instead of the physical harddisks.

LVM requires the following.

  • device-mapper support in the Linux kernel (default for Debian kernels)

  • the userspace device-mapper support library (libdevmapper* package)

  • the userspace LVM2 tools (lvm2 package)

Please start learning LVM2 from the following manpages.

  • lvm(8): Basics of LVM2 mechanism (list of all LVM2 commands)

  • lvm.conf(5): Configuration file for LVM2

  • lvs(8): Report information about logical volumes

  • vgs(8): Report information about volume groups

  • pvs(8): Report information about physical volumes

Filesystem configuration

For ext4 filesystem, the e2fsprogs package provides the following.

  • mkfs.ext4(8) to create new ext4 filesystem

  • fsck.ext4(8) to check and to repair existing ext4 filesystem

  • tune2fs(8) to configure superblock of ext4 filesystem

  • debugfs(8) to debug ext4 filesystem interactively. (It has undel command to recover deleted files.)

The mkfs(8) and fsck(8) commands are provided by the e2fsprogs package as front-ends to various filesystem dependent programs (mkfs.fstype and fsck.fstype). For ext4 filesystem, they are mkfs.ext4(8) and fsck.ext4(8) (they are symlinked to mke2fs(8) and e2fsck(8)).

Similar commands are available for each filesystem supported by Linux.

package popcon size description
e2fsprogs @-@popcon1@-@ @-@psize1@-@ utilities for the ext2/ext3/ext4 filesystems
btrfs-progs @-@popcon1@-@ @-@psize1@-@ utilities for the Btrfs filesystem
reiserfsprogs @-@popcon1@-@ @-@psize1@-@ utilities for the Reiserfs filesystem
zfsutils-linux @-@popcon1@-@ @-@psize1@-@ utilities for the OpenZFS filesystem
dosfstools @-@popcon1@-@ @-@psize1@-@ utilities for the FAT filesystem. (Microsoft: MS-DOS, Windows)
exfatprogs @-@popcon1@-@ @-@psize1@-@ utilities for the exFAT filesystem maintained by Samsung.
exfat-fuse @-@popcon1@-@ @-@psize1@-@ read/write exFAT filesystem (Microsoft) driver for FUSE.
xfsprogs @-@popcon1@-@ @-@psize1@-@ utilities for the XFS filesystem. (SGI: IRIX)
ntfs-3g @-@popcon1@-@ @-@psize1@-@ read/write NTFS filesystem (Microsoft: Windows NT, …) driver for FUSE.
jfsutils @-@popcon1@-@ @-@psize1@-@ utilities for the JFS filesystem. (IBM: AIX, OS/2)
xorriso @-@popcon1@-@ @-@psize1@-@ utilities for the ISO-9660 filesystem and CD/DVD writing from libburnia
wodim @-@popcon1@-@ @-@psize1@-@ command line CD/DVD writing tool from cdrkit
genisoimage @-@popcon1@-@ @-@psize1@-@ command line ISO-9660 filesystem tool from cdrkit
reiser4progs @-@popcon1@-@ @-@psize1@-@ utilities for the Reiser4 filesystem
hfsprogs @-@popcon1@-@ @-@psize1@-@ utilities for HFS and HFS Plus filesystem. (Apple: Mac OS)
zerofree @-@popcon1@-@ @-@psize1@-@ program to zero free blocks from ext2/3/4 filesystems

List of filesystem management packages

[!TIP] Ext4 filesystem is the default filesystem for the Linux system and strongly recommended to use it unless you have some specific reasons not to.

Btrfs status can be found at Debian wiki on btrfs and kernel.org wiki on btrfs. It is expected to be the next default filesystem after the ext4 filesystem.

Some tools allow access to filesystem without Linux kernel support (see Manipulating files without mounting disk).

Filesystem creation and integrity check

The mkfs(8) command creates the filesystem on a Linux system. The fsck(8) command provides the filesystem integrity check and repair on a Linux system.

Debian now defaults to no periodic fsck after filesystem creation.

[!CAUTION] It is generally not safe to run fsck on mounted filesystems.

[!TIP] You can run the fsck(8) command safely on all filesystems including root filesystem on reboot by setting "enable_periodic_fsck" in "/etc/mke2fs.conf" and the max mount count to 0 using "tune2fs -c0 /dev/partition_name". See mke2fs.conf(5) and tune2fs(8).

Check files in "/var/log/fsck/" for the result of the fsck(8) command run from the boot script.

Optimization of filesystem by mount options

The basic static filesystem configuration is given by "/etc/fstab". For example,

«file system»                   «mount point» «type» «options»    «dump» «pass»
proc                                      /proc proc   defaults          0 0
UUID=709cbe4c-80c1-56db-8ab1-dbce3146d2f7 /     ext4   errors=remount-ro 0 1
UUID=817bae6b-45d2-5aca-4d2a-1267ab46ac23 none  swap   sw                0 0
/dev/scd0                        /media/cdrom0  udf,iso9660 user,noauto  0 0

[!TIP] UUID (see Accessing partition using UUID) may be used to identify a block device instead of normal block device names such as "/dev/sda1", "/dev/sda2", …

Since Linux 2.6.30, the kernel defaults to the behavior provided by "relatime" option.

See fstab(5) and mount(8).

Optimization of filesystem via superblock

Characteristics of a filesystem can be optimized via its superblock using the tune2fs(8) command.

  • Execution of "sudo tune2fs -l /dev/sda1" displays the contents of the filesystem superblock on "/dev/sda1".

  • Execution of "sudo tune2fs -c 50 /dev/sda1" changes frequency of filesystem checks (fsck execution during boot-up) to every 50 boots on "/dev/sda1".

  • Execution of "sudo tune2fs -j /dev/sda1" adds journaling capability to the filesystem, i.e. filesystem conversion from ext2 to ext3 on "/dev/sda1". (Do this on the unmounted filesystem.)

  • Execution of "sudo tune2fs -O extents,uninit_bg,dir_index /dev/sda1 && fsck -pf /dev/sda1" converts it from ext3 to ext4 on "/dev/sda1". (Do this on the unmounted filesystem.)

[!TIP] Despite its name, tune2fs(8) works not only on the ext2 filesystem but also on the ext3 and ext4 filesystems.

Optimization of hard disk

[!WARNING] Please check your hardware and read manpage of hdparm(8) before playing with hard disk configuration because this may be quite dangerous for the data integrity.

You can test disk access speed of a hard disk, e.g. "/dev/sda", by "hdparm -tT /dev/sda". For some hard disk connected with (E)IDE, you can speed it up with "hdparm -q -c3 -d1 -u1 -m16 /dev/sda" by enabling the "(E)IDE 32-bit I/O support", enabling the "using_dma flag", setting "interrupt-unmask flag", and setting the "multiple 16 sector I/O" (dangerous!).

You can test write cache feature of a hard disk, e.g. "/dev/sda", by "hdparm -W /dev/sda". You can disable its write cache feature with "hdparm -W 0 /dev/sda".

You may be able to read badly pressed CDROMs on modern high speed CD-ROM drive by slowing it down with "setcd -x 2".

Optimization of solid state drive

Solid state drive (SSD) is auto detected now.

Reduce unnecessary disk accesses to prevent disk wear out by mounting "tmpfs" on volatile data path in /etc/fstab.

Using SMART to predict hard disk failure

You can monitor and log your hard disk which is compliant to SMART with the smartd(8) daemon.

  1. Enable SMART feature in BIOS.

  2. Install the smartmontools package.

  3. Identify your hard disk drives by listing them with df(1).

    • Let's assume a hard disk drive to be monitored as "/dev/sda".
  4. Check the output of "smartctl -a /dev/sda" to see if SMART feature is actually enabled.

    • If not, enable it by "smartctl -s on -a /dev/sda".
  5. Enable smartd(8) daemon to run by the following.

    • uncomment "start_smartd=yes" in the "/etc/default/smartmontools" file.

    • restart the smartd(8) daemon by "sudo systemctl restart smartmontools".

[!TIP] The smartd(8) daemon can be customized with the /etc/smartd.conf file including how to be notified of warnings.

Specify temporary storage directory via $TMPDIR

Applications create temporary files normally under the temporary storage directory "/tmp". If "/tmp" does not provide enough space, you can specify such temporary storage directory via the $TMPDIR variable for well-behaving programs.

Expansion of usable storage space via LVM

For partitions created on Logical Volume Manager (LVM) (Linux feature) at install time, they can be resized easily by concatenating extents onto them or truncating extents from them over multiple storage devices without major system reconfiguration.

Expansion of usable storage space by mounting another partition

If you have an empty partition (e.g., "/dev/sdx"), you can format it with mkfs.ext4(1) and mount(8) it to a directory where you need more space. (You need to copy original data contents.)

$ sudo mv work-dir old-dir
$ sudo mkfs.ext4 /dev/sdx
$ sudo mount -t ext4 /dev/sdx work-dir
$ sudo cp -a old-dir/* work-dir
$ sudo rm -rf old-dir

[!TIP] You may alternatively mount an empty disk image file (see Making the empty disk image file) as a loop device (see Mounting the disk image file). The actual disk usage grows with the actual data stored.

Expansion of usable storage space by bind-mounting another directory

If you have an empty directory (e.g., "/path/to/emp-dir") on another partition with usable space, you can mount(8) it with "--bind" option to a directory (e.g., "work-dir") where you need more space.

$ sudo mount --bind /path/to/emp-dir work-dir

Expansion of usable storage space by overlay-mounting another directory

If you have usable space in another partition (e.g., "/path/to/empty" and "/path/to/work"), you can create a directory in it and stack that on to an old directory (e.g., "/path/to/old") where you need space using the OverlayFS for Linux kernel 3.18 or newer (Debian Stretch 9.0 or newer).

$ sudo mount -t overlay overlay \
  -olowerdir=/path/to/old-dir,upperdir=/path/to/empty,workdir=/path/to/work

Here, "/path/to/empty" and "/path/to/work" should be on the RW-enabled partition to write on "/path/to/old".

Expansion of usable storage space using symlink

[!CAUTION] This is a deprecated method. Some software may not function well with "symlink to a directory". Instead, use the "mounting" approaches described in the above.

If you have an empty directory (e.g., "/path/to/emp-dir") in another partition with usable space, you can create a symlink to the directory with ln(8).

$ sudo mv work-dir old-dir
$ sudo mkdir -p /path/to/emp-dir
$ sudo ln -sf /path/to/emp-dir work-dir
$ sudo cp -a old-dir/* work-dir
$ sudo rm -rf old-dir

[!WARNING] Do not use "symlink to a directory" for directories managed by the system such as "/opt". Such a symlink may be overwritten when the system is upgraded.

The disk image

Here, we discuss manipulations of the disk image.

Making the disk image file

The disk image file, "disk.img", of an unmounted device, e.g., the second SCSI or serial ATA drive "/dev/sdb", can be made by one of the following.

# dd if=/dev/sdb of=disk.img; sync

# cp /dev/sdb disk.img ; sync

# cat /dev/sdb > disk.img ; sync

The disk image of the traditional PC's master boot record (MBR) (see Disk partition configuration) which reside on the first sector on the primary IDE disk can be made by using dd(1) by the following.

# dd if=/dev/sda of=mbr.img bs=512 count=1
# dd if=/dev/sda of=mbr-nopart.img bs=446 count=1
# dd if=/dev/sda of=mbr-part.img skip=446 bs=1 count=66
  • "mbr.img": The MBR with the partition table

  • "mbr-nopart.img": The MBR without the partition table

  • "mbr-part.img": The partition table of the MBR only

If you are making an image of a disk partition of the original disk, substitute "/dev/sda" with "/dev/sda1" etc.

Writing directly to the disk

The disk image file, "disk.img" can be written to an unmounted device, e.g., the second SCSI drive "/dev/sdb" with matching size, by one of the following.

# dd if=disk.img of=/dev/sdb ; sync

# cp disk.img /dev/sdb ; sync

# cat disk.img >/dev/sdb ; sync

Similarly, the disk partition image file, "partition.img" can be written to an unmounted partition, e.g., the first partition of the second SCSI drive "/dev/sdb1" with matching size, by the following.

# dd if=partition.img of=/dev/sdb1 ; sync

Mounting the disk image file

The disk image "partition.img" containing a single partition image can be mounted and unmounted by using the loop device as follows.

# losetup --show -f partition.img
/dev/loop0
# mkdir -p /mnt/loop0
# mount -t auto /dev/loop0 /mnt/loop0
...hack...hack...hack
# umount /dev/loop0
# losetup -d /dev/loop0

This can be simplified as follows.

# mkdir -p /mnt/loop0
# mount -t auto -o loop partition.img /mnt/loop0
...hack...hack...hack
# umount partition.img

Each partition of the disk image "disk.img" containing multiple partitions can be mounted by using the loop device.

# losetup --show -f -P disk.img
/dev/loop0
# ls -l /dev/loop0*
brw-rw---- 1 root disk   7,  0 Apr  2 22:51 /dev/loop0
brw-rw---- 1 root disk 259, 12 Apr  2 22:51 /dev/loop0p1
brw-rw---- 1 root disk 259, 13 Apr  2 22:51 /dev/loop0p14
brw-rw---- 1 root disk 259, 14 Apr  2 22:51 /dev/loop0p15
# fdisk -l /dev/loop0
Disk /dev/loop0: 2 GiB, 2147483648 bytes, 4194304 sectors
Units: sectors of 1 * 512 = 512 bytes
Sector size (logical/physical): 512 bytes / 512 bytes
I/O size (minimum/optimal): 512 bytes / 512 bytes
Disklabel type: gpt
Disk identifier: 6A1D9E28-C48C-2144-91F7-968B3CBC9BD1

Device         Start     End Sectors  Size Type
/dev/loop0p1  262144 4192255 3930112  1.9G Linux root (x86-64)
/dev/loop0p14   2048    8191    6144    3M BIOS boot
/dev/loop0p15   8192  262143  253952  124M EFI System

Partition table entries are not in disk order.
# mkdir -p /mnt/loop0p1
# mkdir -p /mnt/loop0p15
# mount -t auto /dev/loop0p1 /mnt/loop0p1
# mount -t auto /dev/loop0p15 /mnt/loop0p15
# mount |grep loop
/dev/loop0p1 on /mnt/loop0p1 type ext4 (rw,relatime)
/dev/loop0p15 on /mnt/loop0p15 type vfat (rw,relatime,fmask=0002,dmask=0002,allow_utime=0020,codepage=437,iocharset=ascii,shortname=mixed,utf8,errors=remount-ro)
...hack...hack...hack
# umount /dev/loop0p1
# umount /dev/loop0p15
# losetup -d /dev/loop0

Alternatively, similar effects can be done by using the device mapper devices created by kpartx(8) from the kpartx package as follows.

# kpartx -a -v disk.img
add map loop0p1 (253:0): 0 3930112 linear 7:0 262144
add map loop0p14 (253:1): 0 6144 linear 7:0 2048
add map loop0p15 (253:2): 0 253952 linear 7:0 8192
# fdisk -l /dev/loop0
Disk /dev/loop0: 2 GiB, 2147483648 bytes, 4194304 sectors
Units: sectors of 1 * 512 = 512 bytes
Sector size (logical/physical): 512 bytes / 512 bytes
I/O size (minimum/optimal): 512 bytes / 512 bytes
Disklabel type: gpt
Disk identifier: 6A1D9E28-C48C-2144-91F7-968B3CBC9BD1

Device         Start     End Sectors  Size Type
/dev/loop0p1  262144 4192255 3930112  1.9G Linux root (x86-64)
/dev/loop0p14   2048    8191    6144    3M BIOS boot
/dev/loop0p15   8192  262143  253952  124M EFI System

Partition table entries are not in disk order.
# ls -l /dev/mapper/
total 0
crw------- 1 root root 10, 236 Apr  2 22:45 control
lrwxrwxrwx 1 root root       7 Apr  2 23:19 loop0p1 -> ../dm-0
lrwxrwxrwx 1 root root       7 Apr  2 23:19 loop0p14 -> ../dm-1
lrwxrwxrwx 1 root root       7 Apr  2 23:19 loop0p15 -> ../dm-2
# mkdir -p /mnt/loop0p1
# mkdir -p /mnt/loop0p15
# mount -t auto /dev/mapper/loop0p1 /mnt/loop0p1
# mount -t auto /dev/mapper/loop0p15 /mnt/loop0p15
# mount |grep loop
/dev/loop0p1 on /mnt/loop0p1 type ext4 (rw,relatime)
/dev/loop0p15 on /mnt/loop0p15 type vfat (rw,relatime,fmask=0002,dmask=0002,allow_utime=0020,codepage=437,iocharset=ascii,shortname=mixed,utf8,errors=remount-ro)
...hack...hack...hack
# umount /dev/mapper/loop0p1
# umount /dev/mapper/loop0p15
# kpartx -d disk.img

Cleaning a disk image file

A disk image file, "disk.img" can be cleaned of all removed files into clean sparse image "new.img" by the following.

# mkdir old; mkdir new
# mount -t auto -o loop disk.img old
# dd bs=1 count=0 if=/dev/zero of=new.img seek=5G
# mount -t auto -o loop new.img new
# cd old
# cp -a --sparse=always ./ ../new/
# cd ..
# umount new.img
# umount disk.img

If "disk.img" is in ext2, ext3 or ext4, you can also use zerofree(8) from the zerofree package as follows.

# losetup --show -f disk.img
/dev/loop0
# zerofree /dev/loop0
# cp --sparse=always disk.img new.img
# losetup -d /dev/loop0

Making the empty disk image file

The empty disk image "disk.img" which can grow up to 5GiB can be made using dd(1) as follows.

$ dd bs=1 count=0 if=/dev/zero of=disk.img seek=5G

Instead of using dd(1), specialized fallocate(8) may be used here.

You can create an ext4 filesystem on this disk image "disk.img" using the loop device as follows.

# losetup --show -f disk.img
/dev/loop0
# mkfs.ext4 /dev/loop0
...hack...hack...hack
# losetup -d /dev/loop0
$ du  --apparent-size -h disk.img
5.0G  disk.img
$ du -h disk.img
83M disk.img

For "disk.img", its file size is 5.0 GiB and its actual disk usage is mere 83MiB. This discrepancy is possible since ext4 can hold sparse file.

[!TIP] The actual disk usage of sparse file grows with data which are written to it.

Using similar operation on devices created by the loop device or the device mapper devices as Mounting the disk image file, you can partition this disk image "disk.img" using parted(8) or fdisk(8), and can create filesystem on it using mkfs.ext4(8), mkswap(8), etc.

Making the ISO9660 image file

[!TIP] Both genisoimage(1) provided by cdrkit and xorrisofs(1) provided by Libburnia share the same command syntax except for the command name.

The ISO9660 image file, "cd.iso", from the source directory tree at "source_directory" can be made using genisoimage(1) provided by cdrkit by the following.

#  genisoimage -r -J -T -V volume_id -o cd.iso source_directory

Similarly, the bootable ISO9660 image file, "cdboot.iso", can be made from debian-installer like directory tree at "source_directory" by the following.

#  genisoimage -r -o cdboot.iso -V volume_id \
   -b isolinux/isolinux.bin -c isolinux/boot.cat \
   -no-emul-boot -boot-load-size 4 -boot-info-table source_directory

Here Isolinux boot loader (see ???) is used for booting.

You can calculate the md5sum value and make the ISO9660 image directly from the CD-ROM device as follows.

$ isoinfo -d -i /dev/cdrom
CD-ROM is in ISO 9660 format
...
Logical block size is: 2048
Volume size is: 23150592
...
# dd if=/dev/cdrom bs=2048 count=23150592 conv=notrunc,noerror | md5sum
# dd if=/dev/cdrom bs=2048 count=23150592 conv=notrunc,noerror > cd.iso

[!WARNING] You must carefully avoid ISO9660 filesystem read ahead bug of Linux as above to get the right result.

Writing directly to the CD/DVD-R/RW

[!TIP] DVD is only a large CD to wodim(1) provided by cdrkit and xorrecord(1) provided by Libburnia. These commands share the same command syntax except for the command name.

You can find a usable device by the following.

# wodim --devices

Then the blank CD-R is inserted to the CD drive, and the ISO9660 image file, "cd.iso" is written to this device, e.g., "/dev/sda", using wodim(1) by the following.

# wodim -v -eject dev=/dev/sda cd.iso

If CD-RW is used instead of CD-R, do this instead by the following.

# wodim -v -eject blank=fast dev=/dev/sda cd.iso

[!TIP] If your desktop system mounts CDs automatically, unmount it by "sudo umount /dev/sda" from console before using wodim(1).

Mounting the ISO9660 image file

If "cd.iso" contains an ISO9660 image, then the following manually mounts it to "/cdrom".

# mount -t iso9660 -o ro,loop cd.iso /cdrom

[!TIP] Modern desktop system may mount removable media such as ISO9660 formatted CD automatically (see ???).

The binary data

Here, we discuss direct manipulations of the binary data on storage media.

Viewing and editing binary data

The most basic viewing method of binary data is to use "od -t x1" command.

package popcon size description
coreutils @-@popcon1@-@ @-@psize1@-@ basic package which has od(1) to dump files (HEX, ASCII, OCTAL, …)
bsdmainutils @-@popcon1@-@ @-@psize1@-@ utility package which has hd(1) to dump files (HEX, ASCII, OCTAL, …)
hexedit @-@popcon1@-@ @-@psize1@-@ binary editor and viewer (HEX, ASCII)
bless @-@popcon1@-@ @-@psize1@-@ full featured hexadecimal editor (GNOME)
okteta @-@popcon1@-@ @-@psize1@-@ full featured hexadecimal editor (KDE4)
ncurses-hexedit @-@popcon1@-@ @-@psize1@-@ binary editor and viewer (HEX, ASCII, EBCDIC)
beav @-@popcon1@-@ @-@psize1@-@ binary editor and viewer (HEX, ASCII, EBCDIC, OCTAL, …)

List of packages which view and edit binary data

[!TIP] HEX is used as an acronym for hexadecimal format with radix 16. OCTAL is for octal format with radix 8. ASCII is for American Standard Code for Information Interchange, i.e., normal English text code. EBCDIC is for Extended Binary Coded Decimal Interchange Code used on IBM mainframe operating systems.

Manipulating files without mounting disk

There are tools to read and write files without mounting disk.

package popcon size description
mtools @-@popcon1@-@ @-@psize1@-@ utilities for MSDOS files without mounting them
hfsutils @-@popcon1@-@ @-@psize1@-@ utilities for HFS and HFS+ files without mounting them

List of packages to manipulate files without mounting disk

Data redundancy

Software RAID systems offered by the Linux kernel provide data redundancy in the kernel filesystem level to achieve high levels of storage reliability.

There are tools to add data redundancy to files in application program level to achieve high levels of storage reliability, too.

package popcon size description
par2 @-@popcon1@-@ @-@psize1@-@ Parity Archive Volume Set, for checking and repair of files
dvdisaster @-@popcon1@-@ @-@psize1@-@ data loss/scratch/aging protection for CD/DVD media
dvbackup @-@popcon1@-@ @-@psize1@-@ backup tool using MiniDV camcorders (providing rsbep(1))

List of tools to add data redundancy to files

Data file recovery and forensic analysis

There are tools for data file recovery and forensic analysis.

package popcon size description
testdisk @-@popcon1@-@ @-@psize1@-@ utilities for partition scan and disk recovery
magicrescue @-@popcon1@-@ @-@psize1@-@ utility to recover files by looking for magic bytes
scalpel @-@popcon1@-@ @-@psize1@-@ frugal, high performance file carver
myrescue @-@popcon1@-@ @-@psize1@-@ rescue data from damaged harddisks
extundelete @-@popcon1@-@ @-@psize1@-@ utility to undelete files on the ext3/4 filesystem
ext4magic @-@popcon1@-@ @-@psize1@-@ utility to undelete files on the ext3/4 filesystem
ext3grep @-@popcon1@-@ @-@psize1@-@ tool to help recover deleted files on the ext3 filesystem
scrounge-ntfs @-@popcon1@-@ @-@psize1@-@ data recovery program for NTFS filesystems
gzrt @-@popcon1@-@ @-@psize1@-@ gzip recovery toolkit
sleuthkit @-@popcon1@-@ @-@psize1@-@ tools for forensics analysis. (Sleuthkit)
autopsy @-@popcon1@-@ @-@psize1@-@ graphical interface to SleuthKit
foremost @-@popcon1@-@ @-@psize1@-@ forensics application to recover data
guymager @-@popcon1@-@ @-@psize1@-@ forensic imaging tool based on Qt
dcfldd @-@popcon1@-@ @-@psize1@-@ enhanced version of dd for forensics and security

List of packages for data file recovery and forensic analysis

[!TIP] You can undelete files on the ext2 filesystem using list_deleted_inodes and undel commands of debugfs(8) in the e2fsprogs package.

Splitting a large file into small files

When a data is too big to backup as a single file, you can backup its content after splitting it into, e.g. 2000MiB chunks and merge those chunks back into the original file later.

$ split -b 2000m large_file
$ cat x* >large_file

[!CAUTION] Please make sure you do not have any files starting with "x" to avoid name crashes.

Clearing file contents

In order to clear the contents of a file such as a log file, do not use rm(1) to delete the file and then create a new empty file, because the file may still be accessed in the interval between commands. The following is the safe way to clear the contents of the file.

$ :>file_to_be_cleared

Dummy files

The following commands create dummy or empty files.

$ dd if=/dev/zero    of=5kb.file bs=1k count=5
$ dd if=/dev/urandom of=7mb.file bs=1M count=7
$ touch zero.file
$ : > alwayszero.file

You should find following files.

  • "5kb.file" is 5KB of zeros.

  • "7mb.file" is 7MB of random data.

  • "zero.file" may be a 0 byte file. If it existed, its mtime is updated while its content and its length are kept.

  • "alwayszero.file" is always a 0 byte file. If it existed, its mtime is updated and its content is reset.

Erasing an entire hard disk

There are several ways to completely erase data from an entire hard disk like device, e.g., USB flash drive at "/dev/sda".

[!CAUTION] Check your USB flash drive location with mount(8) first before executing commands here. The device pointed by "/dev/sda" may be SCSI hard disk or serial-ATA hard disk where your entire system resides.

Erase all the disk content by resetting data to 0 with the following.

# dd if=/dev/zero of=/dev/sda

Erase everything by overwriting with random data as follows.

# dd if=/dev/urandom of=/dev/sda

Erase everything by overwriting with random data very efficiently as follows.

# shred -v -n 1 /dev/sda

You may alternatively use badblocks(8) with -t random option.

Since dd(1) is available from the shell of many bootable Linux CDs such as Debian installer CD, you can erase your installed system completely by running an erase command from such media on the system hard disk, e.g., "/dev/sda", "/dev/sda", etc.

Erasing unused area of an hard disk

Unused area on an hard disk (or USB flash drive), e.g. "/dev/sdb1" may still contain erased data themselves since they are only unlinked from the filesystem. These can be cleaned by overwriting them.

# mount -t auto /dev/sdb1 /mnt/foo
# cd /mnt/foo
# dd if=/dev/zero of=junk
dd: writing to `junk': No space left on device
...
# sync
# umount /dev/sdb1

[!WARNING] This is usually good enough for your USB flash drive. But this is not perfect. Most parts of erased filenames and their attributes may be hidden and remain in the filesystem.

Undeleting deleted but still open files

Even if you have accidentally deleted a file, as long as that file is still being used by some application (read or write mode), it is possible to recover such a file.

For example, try the following

$ echo foo > bar
$ less bar
$ ps aux | grep ' less[ ]'
bozo    4775  0.0  0.0  92200   884 pts/8    S+   00:18   0:00 less bar
$ rm bar
$ ls -l /proc/4775/fd | grep bar
lr-x------ 1 bozo bozo 64 2008-05-09 00:19 4 -> /home/bozo/bar (deleted)
$ cat /proc/4775/fd/4 >bar
$ ls -l
-rw-r--r-- 1 bozo bozo 4 2008-05-09 00:25 bar
$ cat bar
foo

Execute on another terminal (when you have the lsof package installed) as follows.

$ ls -li bar
2228329 -rw-r--r-- 1 bozo bozo 4 2008-05-11 11:02 bar
$ lsof |grep bar|grep less
less 4775 bozo 4r REG 8,3 4 2228329 /home/bozo/bar
$ rm bar
$ lsof |grep bar|grep less
less 4775 bozo 4r REG 8,3 4 2228329 /home/bozo/bar (deleted)
$ cat /proc/4775/fd/4 >bar
$ ls -li bar
2228302 -rw-r--r-- 1 bozo bozo 4 2008-05-11 11:05 bar
$ cat bar
foo

Searching all hardlinks

$ ls -li
total 0
2738405 -rw-r--r-- 1 root root 0 2008-09-15 20:21 bar
2738404 -rw-r--r-- 2 root root 0 2008-09-15 20:21 baz
2738404 -rw-r--r-- 2 root root 0 2008-09-15 20:21 foo

Both "baz" and "foo" have link counts of "2" (>1) showing them to have hardlinks. Their inode numbers are common "2738404". This means they are the same hardlinked file. If you do not happen to find all hardlinked files by chance, you can search it by the inode, e.g., "2738404" as the following.

# find /path/to/mount/point -xdev -inum 2738404

Invisible disk space consumption

All deleted but open files consume disk space although they are not visible from normal du(1). They can be listed with their size by the following.

# lsof -s -X / |grep deleted

Data encryption tips

With physical access to your PC, anyone can easily gain root privilege and access all the files on your PC (see ???). This means that login password system can not secure your private and sensitive data against possible theft of your PC. You must deploy data encryption technology to do it. Although GNU privacy guard (see ???) can encrypt files, it takes some user efforts.

Dm-crypt facilitates automatic data encryption via native Linux kernel modules with minimal user efforts using device-mapper.

package popcon size description
cryptsetup @-@popcon1@-@ @-@psize1@-@ utilities for encrypted block device (dm-crypt / LUKS)
cryptmount @-@popcon1@-@ @-@psize1@-@ utilities for encrypted block device (dm-crypt / LUKS) with focus on mount/unmount by normal users
fscrypt @-@popcon1@-@ @-@psize1@-@ utilities for Linux filesystem encryption (fscrypt)
libpam-fscrypt @-@popcon1@-@ @-@psize1@-@ PAM module for Linux filesystem encryption (fscrypt)

List of data encryption utilities

[!CAUTION] Data encryption costs CPU time etc. Encrypted data becomes inaccessible if its password is lost. Please weigh its benefits and costs.

[!NOTE] Entire Debian system can be installed on a encrypted disk by the debian-installer (lenny or newer) using dm-crypt/LUKS and initramfs.

[!TIP] See ??? for user space encryption utility: GNU Privacy Guard.

Removable disk encryption with dm-crypt/LUKS

You can encrypt contents of removable mass devices, e.g. USB flash drive on "/dev/sdx", using dm-crypt/LUKS. You simply format it as the following.

# fdisk /dev/sdx
... "n" "p" "1" "return" "return" "w"
# cryptsetup luksFormat /dev/sdx1
...
# cryptsetup open /dev/sdx1 secret
...
# ls -l /dev/mapper/
total 0
crw-rw---- 1 root root  10, 60 2021-10-04 18:44 control
lrwxrwxrwx 1 root root       7 2021-10-04 23:55 secret -> ../dm-0
# mkfs.vfat /dev/mapper/secret
...
# cryptsetup close secret

Then, it can be mounted just like normal one on to "/media/username/disk_label", except for asking password (see ???) under modern desktop environment using the udisks2 package. The difference is that every data written to it is encrypted. The password entry may be automated using keyring (see ???).

You may alternatively format media in different filesystem, e.g., ext4 with "mkfs.ext4 /dev/mapper/sdx1". If btrfs is used instead, the udisks2-btrfs package needs to be installed. For these filesystems, the file ownership and permissions may need to be configured.

Mounting encrypted disk with dm-crypt/LUKS

For example, an encrypted disk partition created with dm-crypt/LUKS on "/dev/sdc5" by Debian Installer can be mounted onto "/mnt" as follows:

$ sudo cryptsetup open /dev/sdc5 ninja --type luks
Enter passphrase for /dev/sdc5: ****
$ sudo lvm
lvm> lvscan
  inactive          '/dev/ninja-vg/root' [13.52 GiB] inherit
  inactive          '/dev/ninja-vg/swap_1' [640.00 MiB] inherit
  ACTIVE            '/dev/goofy/root' [180.00 GiB] inherit
  ACTIVE            '/dev/goofy/swap' [9.70 GiB] inherit
lvm> lvchange -a y /dev/ninja-vg/root
lvm> exit
  Exiting.
$ sudo mount /dev/ninja-vg/root /mnt

The kernel

Debian distributes modularized Linux kernel as packages for supported architectures.

If you are reading this documentation, you probably don't need to compile Linux kernel by yourself.

Kernel parameters

Many Linux features are configurable via kernel parameters as follows.

  • Kernel parameters initialized by the bootloader (see ???)

  • Kernel parameters changed by sysctl(8) at runtime for ones accessible via sysfs (see ???)

  • Module parameters set by arguments of modprobe(8) when a module is activated (see Mounting the disk image file)

See "The Linux kernel user’s and administrator’s guide » The kernel’s command-line parameters" for the detail.

Kernel headers

Most normal programs don't need kernel headers and in fact may break if you use them directly for compiling. They should be compiled against the headers in "/usr/include/linux" and "/usr/include/asm" provided by the libc6-dev package (created from the glibc source package) on the Debian system.

[!NOTE] For compiling some kernel-specific programs such as the kernel modules from the external source and the automounter daemon (amd), you must include path to the corresponding kernel headers, e.g. "-I/usr/src/linux-particular-version/include/", to your command line.

Compiling the kernel and related modules

Debian has its own method of compiling the kernel and related modules.

package popcon size description
build-essential @-@popcon1@-@ @-@psize1@-@ essential packages for building Debian packages: make, gcc, …
bzip2 @-@popcon1@-@ @-@psize1@-@ compress and decompress utilities for bz2 files
libncurses5-dev @-@popcon1@-@ @-@psize1@-@ developer's libraries and docs for ncurses
git @-@popcon1@-@ @-@psize1@-@ git: distributed revision control system used by the Linux kernel
fakeroot @-@popcon1@-@ @-@psize1@-@ provide fakeroot environment for building package as non-root
initramfs-tools @-@popcon1@-@ @-@psize1@-@ tool to build an initramfs (Debian specific)
dkms @-@popcon1@-@ @-@psize1@-@ dynamic kernel module support (DKMS) (generic)
module-assistant @-@popcon1@-@ @-@psize1@-@ helper tool to make module package (Debian specific)
devscripts @-@popcon1@-@ @-@psize1@-@ helper scripts for a Debian Package maintainer (Debian specific)

List of key packages to be installed for the kernel recompilation on the Debian system

If you use initrd in ???, make sure to read the related information in initramfs-tools(8), update-initramfs(8), mkinitramfs(8) and initramfs.conf(5).

[!WARNING] Do not put symlinks to the directories in the source tree (e.g. "/usr/src/linux*") from "/usr/include/linux" and "/usr/include/asm" when compiling the Linux kernel source. (Some outdated documents suggest this.)

[!NOTE] When compiling the latest Linux kernel on the Debian stable system, the use of backported latest tools from the Debian unstable may be needed.

module-assistant(8) (or its short form m-a) helps users to build and install module package(s) easily for one or more custom kernels.

The dynamic kernel module support (DKMS) is a new distribution independent framework designed to allow individual kernel modules to be upgraded without changing the whole kernel. This is used for the maintenance of out-of-tree modules. This also makes it very easy to rebuild modules as you upgrade kernels.

Compiling the kernel source: Debian Kernel Team recommendation

For building custom kernel binary packages from the upstream kernel source, you should use the "deb-pkg" target provided by it.

$ sudo apt-get build-dep linux
$ cd /usr/src
$ wget https://mirrors.edge.kernel.org/pub/linux/kernel/v@linux_version_x@.x/linux-@linux_version@.tar.xz
$ tar --xz -xvf linux-@linux_version@.tar.xz
$ cd linux-@linux_version@
$ cp /boot/config-@linux_version@.config
$ make menuconfig
 ...
$ make deb-pkg

[!TIP] The linux-source-version package provides the Linux kernel source with Debian patches as "/usr/src/linux-version.tar.bz2".

For building specific binary packages from the Debian kernel source package, you should use the "binary-arch_architecture_featureset_flavour" targets in "debian/rules.gen".

$ sudo apt-get build-dep linux
$ apt-get source linux
$ cd linux-@linux_version_x@.*
$ fakeroot make -f debian/rules.gen binary-arch_i386_none_686

See further information:

Hardware drivers and firmware

The hardware driver is the code running on the main CPUs of the target system. Most hardware drivers are available as free software now and are included in the normal Debian kernel packages in the main area.

  • GPU driver

    • Intel GPU driver (main)

    • AMD/ATI GPU driver (main)

    • NVIDIA GPU driver (main for nouveau driver, and non-free for binary-only drivers supported by the vendor.)

The firmware is the code or data loaded on the device attach to the target system (e.g., CPU microcode, rendering code running on GPU, or FPGA / CPLD data, …). Some firmware packages are available as free software but many firmware packages are not available as free software since they contain sourceless binary data. Installing these firmware data is essential for the device to function as expected.

  • The firmware data packages containing data loaded to the volatile memory on the target device.

    • firmware-linux-free (main)

    • firmware-linux-nonfree (non-free-firmware)

    • firmware-linux-* (non-free-firmware)

    • *-firmware (non-free-firmware)

    • intel-microcode (non-free-firmware)

    • amd64-microcode (non-free-firmware)

  • The firmware update program packages which update data on the non-volatile memory on the target device.

    • fwupd (main): Firmware update daemon which downloads firmware data from Linux Vendor Firmware Service.

    • gnome-firmware (main): GTK front end for fwupd

    • plasma-discover-backend-fwupd (main): Qt front end for fwupd

Please note that access to non-free-firmware packages are provided by the official installation media to offer functional installation experience to the user since Debian 12 Bookworm. The non-free-firmware area is described in ???.

Please also note that the firmware data downloaded by fwupd from Linux Vendor Firmware Service and loaded to the running Linux kernel may be non-free.

Virtualized system

Use of virtualized system enables us to run multiple instances of system simultaneously on a single hardware.

[!TIP] See Debian wiki on SystemVirtualization.

Virtualization and emulation tools

There are several virtualization and emulation tool platforms.

  • Complete hardware emulation packages such as ones installed by the games-emulator metapackage

  • Mostly CPU level emulation with some I/O device emulations such as QEMU

  • Mostly CPU level virtualization with some I/O device emulations such as Kernel-based Virtual Machine (KVM)

  • OS level container virtualization with the kernel level support such as LXC (Linux Containers), Docker, systemd-nspawn(1), ...

  • OS level filesystem access virtualization with the system library call override on the file path such as chroot

  • OS level filesystem access virtualization with the system library call override on the file ownership such as fakeroot

  • OS API emulation such as Wine

  • Interpreter level virtualization with its executable selection and run-time library overrides such as virtualenv and venv for Python

The container virtualization uses ??? and is the backend technology of ???.

Here are some packages to help you to setup the virtualized system.

package popcon size description
coreutils @-@popcon1@-@ @-@psize1@-@ GNU core utilities which contain chroot(8)
util-linux @-@popcon1@-@ @-@psize1@-@ miscellaneous system utilities which contain unshare(1)
systemd-container @-@popcon1@-@ @-@psize1@-@ systemd container/nspawn tools which contain systemd-nspawn(1)
schroot @-@popcon1@-@ @-@psize1@-@ specialized tool for executing Debian binary packages in chroot
sbuild @-@popcon1@-@ @-@psize1@-@ tool for building Debian binary packages from Debian sources
debootstrap @-@popcon1@-@ @-@psize1@-@ bootstrap a basic Debian system (written in sh)
mmdebstrap @-@popcon1@-@ @-@psize1@-@ bootstrap a Debian system (written in Perl)
cdebootstrap @-@popcon1@-@ @-@psize1@-@ bootstrap a Debian system (written in C)
cloud-image-utils @-@popcon1@-@ @-@psize1@-@ cloud image management utilities
cloud-guest-utils @-@popcon1@-@ @-@psize1@-@ cloud guest utilities
virt-manager @-@popcon1@-@ @-@psize1@-@ Virtual Machine Manager: desktop application for managing virtual machines
libvirt-clients @-@popcon1@-@ @-@psize1@-@ programs for the libvirt library
docker.io @-@popcon1@-@ @-@psize1@-@ docker: Linux container runtime
podman @-@popcon1@-@ @-@psize1@-@ podman: engine to run OCI-based containers in Pods
podman-docker @-@popcon1@-@ @-@psize1@-@ engine to run OCI-based containers in Pods - wrapper for docker
incus @-@popcon1@-@ @-@psize1@-@ Incus: system container and virtual machine manager
games-emulator @-@popcon1@-@ @-@psize1@-@ games-emulator: Debian's emulators for games
bochs @-@popcon1@-@ @-@psize1@-@ Bochs: IA-32 PC emulator
qemu-system @-@popcon1@-@ @-@psize1@-@ QEMU: full system emulation binaries
qemu-user @-@popcon1@-@ @-@psize1@-@ QEMU: user mode emulation binaries
qemu-utils @-@popcon1@-@ @-@psize1@-@ QEMU: utilities
qemu-system-x86 @-@popcon1@-@ @-@psize1@-@ KVM: full virtualization on x86 hardware with the hardware-assisted virtualization
virtualbox @-@popcon1@-@ @-@psize1@-@ VirtualBox: x86 virtualization solution on i386 and amd64
gnome-boxes @-@popcon1@-@ @-@psize1@-@ Boxes: Simple GNOME app to access virtual systems
xen-tools @-@popcon1@-@ @-@psize1@-@ tools to manage debian XEN virtual server
wine @-@popcon1@-@ @-@psize1@-@ Wine: Windows API Implementation (standard suite)
dosbox @-@popcon1@-@ @-@psize1@-@ DOSBox: x86 emulator with Tandy/Herc/CGA/EGA/VGA/SVGA graphics, sound and DOS
lxc @-@popcon1@-@ @-@psize1@-@ Linux containers user space tools
python3-venv @-@popcon1@-@ @-@psize1@-@ venv for creating virtual python environments (system library)
python3-virtualenv @-@popcon1@-@ @-@psize1@-@ virtualenv for creating isolated virtual python environments
pipx @-@popcon1@-@ @-@psize1@-@ pipx for installing python applications in isolated environments

List of virtualization tools

See Wikipedia article Comparison of platform virtual machines for detail comparison of different platform virtualization solutions.

Virtualization work flow

[!NOTE] Default Debian kernels support KVM since lenny.

Typical work flow for virtualization involves several steps.

Mounting the virtual disk image file

For the raw disk image file, see The disk image.

For other virtual disk image files, you can use qemu-nbd(8) to export them using network block device protocol and mount them using the nbd kernel module.

qemu-nbd(8) supports disk formats supported by QEMU: raw, qcow2, qcow, vmdk, vdi, bochs, cow (user-mode Linux copy-on-write), parallels, dmg, cloop, vpc, vvfat (virtual VFAT), and host_device.

The network block device can support partitions in the same way as the loop device (see Mounting the disk image file). You can mount the first partition of "disk.img" as follows.

# modprobe nbd max_part=16
# qemu-nbd -v -c /dev/nbd0 disk.img
...
# mkdir /mnt/part1
# mount /dev/nbd0p1 /mnt/part1

[!TIP] You may export only the first partition of "disk.img" using "-P 1" option to qemu-nbd(8).

Chroot system

If you wish to try a new Debian environment from a terminal console, I recommend you to use chroot. This enables you to run console applications of Debian unstable and testing without usual risks associated and without rebooting. chroot(8) is the most basic way.

[!CAUTION] Examples below assumes both parent system and chroot system share the same amd64 CPU architecture.

Although you can manually create a chroot(8) environment using debootstrap(1), this requires non-trivial efforts.

The sbuild package to build Debian packages from source uses the chroot environment managed by the schroot package. It comes with helper script sbuild-createchroot(1). Let's learn how it works by running it as follows.

$ sudo mkdir -p /srv/chroot
$ sudo sbuild-createchroot -v --include=eatmydata,ccache unstable /srv/chroot/unstable-amd64-sbuild http://deb.debian.org/debian
 ...

You see how debootstrap(8) populates system data for unstable environment under "/srv/chroot/unstable-amd64-sbuild" for a minimal build system.

You can login to this environment using schroot(1).

$ sudo schroot -v -c chroot:unstable-amd64-sbuild

You see how a system shell running under unstable environment is created.

[!NOTE] The "/usr/sbin/policy-rc.d" file which always exits with 101 prevents daemon programs to be started automatically on the Debian system. See "/usr/share/doc/init-system-helpers/README.policy-rc.d.gz".

[!NOTE] Some programs under chroot may require access to more files from the parent system to function than sbuild-createchroot provides as above. For example, "/sys", "/etc/passwd", "/etc/group", "/var/run/utmp", "/var/log/wtmp", etc. may need to be bind-mounted or copied.

[!TIP] The sbuild package helps to construct a chroot system and builds a package inside the chroot using schroot as its backend. It is an ideal system to check build-dependencies. See more on sbuild at Debian wiki and sbuild configuration example in "Guide for Debian Maintainers".

[!TIP] The systemd-nspawn(1) command helps to run a command or OS in a light-weight container in similar ways to chroot. It is more powerful since it uses namespaces to fully virtualize the the process tree, IPC, hostname, domain name and, optionally, networking and user databases. See systemd-nspawn.

Multiple desktop systems

If you wish to try a new GUI Desktop environment of any OS, I recommend you to use QEMU or KVM on a Debian stable system to run multiple desktop systems safely using virtualization. These enable you to run any desktop applications including ones of Debian unstable and testing without usual risks associated with them and without rebooting.

Since pure QEMU is very slow, it is recommended to accelerate it with KVM when the host system supports it.

Virtual Machine Manager also known as virt-manager is a convenient GUI tool for managing KVM virtual machines via libvirt.

The virtual disk image "virtdisk.qcow2" containing a Debian system for QEMU can be created using debian-installer: Small CDs as follows.

$ wget https://cdimage.debian.org/debian-cd/5.0.3/amd64/iso-cd/debian-503-amd64-netinst.iso
$ qemu-img create -f qcow2 virtdisk.qcow2 5G
$ qemu -hda virtdisk.qcow2 -cdrom debian-503-amd64-netinst.iso -boot d -m 256
...

[!TIP] Running other GNU/Linux distributions such as Ubuntu and Fedora under virtualization is a great way to learn configuration tips. Other proprietary OSs may be run nicely under this GNU/Linux virtualization, too.

See more tips at Debian wiki: SystemVirtualization.

[^1]: More elaborate customization examples: "Vim Galore", "sensible.vim", ...

[^2]: vim-pathogen was popular.