<?xml version='1.0' encoding='utf-8'?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<article lang="en-GB">
  <!-- This file is the translatable part of the Debian Reference Card. -->
  <title>Debian Reference Card</title>
  <!-- subtitle not on printed card, but as 'pdfsubject' in the PDF
       file -->
  <subtitle>The 101 most important things when using Debian</subtitle>
  <articleinfo>
    <copyright>
      <year>2004</year>
      <year>2010</year>
      <holder>W. Martin Borgert</holder>
    </copyright>
    <copyright>
      <year>2016</year>
      <year>2019</year>
      <year>2023</year>
      <holder>Holger Wansing</holder>
    </copyright>
    <copyright>
      <year>2023</year>
      <holder>Your Name ("Language")</holder>
    </copyright>
    <legalnotice>
      <para>This document may be used under the terms of the GNU General
      Public License version 3 or higher. The license text can be found at <ulink
      url="https://www.gnu.org/copyleft/gpl.html"><filename>https://www.gnu.org/copyleft/gpl.html</filename></ulink>
      and
      <filename>/usr/share/common-licenses/GPL-3</filename>.</para>
    </legalnotice>
    <keywordset>
      <keyword>APT</keyword>
      <keyword>Debian</keyword>
      <keyword>dpkg</keyword>
      <keyword>reference card</keyword>
      <keyword>basic commands</keyword>
      <keyword role="version">Version</keyword>
      <keyword role="madeby">Made by</keyword>
    </keywordset>
  </articleinfo>
  <section id="help">
    <title>Getting Help</title>
    <glosslist>
      <glossentry id="man">
	<glossterm>man <replaceable>page</replaceable> or man
	bash</glossterm>
	<glossdef><para>Read help page for every command and many
	configuration files. Also available online:
	<filename>https://www.manpages.debian.org/</filename></para></glossdef>
      </glossentry>
      <glossentry id="command-help">
	<glossterm><replaceable>command</replaceable> &#x00A0;
	<optional><filename>--</filename>help,
	<filename>-</filename>h</optional></glossterm>
	<glossdef><para>Brief help for most
	commands.</para></glossdef>
      </glossentry>
      <glossentry id="usr-share-doc">
	<glossterm><filename>/usr/share/doc/<optional><replaceable>package-name</replaceable>/</optional></filename></glossterm>
	<glossdef><para>Find all documentation here, optional file
	<filename>README.Debian</filename> contains
	specifics.</para></glossdef>
      </glossentry>
      <glossentry id="www-debian-org">
	<glossterm><ulink url="https://www.debian.org/doc/">Web
	documentation</ulink></glossterm>
	<glossdef><para>Reference, manuals, FAQs, HOWTOs, etc. at
	<filename>https://www.debian.org/doc/</filename></para></glossdef>
      </glossentry>
      <glossentry id="lists-debian-org">
	<glossterm><ulink url="https://lists.debian.org/">Mailing
	lists</ulink> at
	<filename>https://lists.debian.org/</filename></glossterm>
	<glossdef><para>The community is always helpful, search for
	<filename>users</filename>. Or use other channels like IRC:
	<filename>https://www.debian.org/support/</filename></para></glossdef>
      </glossentry>
      <glossentry id="wiki-debian-org">
	<glossterm><ulink url="https://wiki.debian.org/">The Wiki</ulink> at
	<filename>https://wiki.debian.org/</filename></glossterm>
	<glossdef><para>Contains all kind of useful
	information.</para></glossdef>
      </glossentry>
    </glosslist>
  </section>
  <section id="d-i">
    <title>Installation</title>
    <glosslist>
      <glossentry id="installer">
	<glossterm><ulink
	url="https://www.debian.org/devel/debian-installer/">Installer</ulink></glossterm>
	<glossdef><para>All information about it at
	<filename>https://www.debian.org/devel/debian-installer/</filename></para></glossdef>
      </glossentry>
      <glossentry id="installer-image">
	<glossterm><ulink
	url="https://www.debian.org/distrib/">CD
	images</ulink></glossterm>
	<glossdef><para>Download from
	<filename>https://www.debian.org/distrib/</filename></para></glossdef>
      </glossentry>
      <glossentry id="boot-expert">
	<glossterm><filename>boot: expert</filename></glossterm>
	<glossdef><para>E.g. to set up the network w/o DHCP or to adapt
	bootloader installation.</para></glossdef>
      </glossentry>
      <glossentry id="live-installer">
	<glossterm>Or use a <ulink
	url="https://www.debian.org/CD/live/">Live image</ulink></glossterm>
	<glossdef><para>Containing the user-friendly Calamares installer:
	<filename>https://www.debian.org/CD/live/</filename></para></glossdef>
      </glossentry>
    </glosslist>
  </section>
  <section id="bugs">
    <title>Bugs</title>
    <glosslist>
      <glossentry id="bugs-debian-org">
	<glossterm><ulink url="https://bugs.debian.org/">Bug
	Tracking</ulink> at
	<filename>https://bugs.debian.org/</filename></glossterm>
	<glossdef><para>All about existing and fixed
	bugs.</para></glossdef>
      </glossentry>
      <glossentry id="bugs-debian-org-package">
	<glossterm>Package specific</glossterm>
	<glossdef><para>See
	<filename>https://bugs.debian.org/<replaceable>package-name</replaceable>/</filename>,
	use <filename>wnpp</filename> to ask for new
	packages.</para></glossdef>
      </glossentry>
      <glossentry id="reportbug">
	<glossterm>reportbug</glossterm>
	<glossdef><para>Report a bug by e-mail.</para></glossdef>
      </glossentry>
      <glossentry id="reporting">
	<glossterm><ulink
	url="https://www.debian.org/Bugs/Reporting">Reporting</ulink></glossterm>
	<glossdef><para>Instructions at
	<filename>https://www.debian.org/Bugs/Reporting</filename></para></glossdef>
      </glossentry>
    </glosslist>
  </section>
  <section id="configuration">
    <title>Configuration</title>
    <glosslist>
      <glossentry id="etc">
	<glossterm><filename>/etc/</filename></glossterm>
	<glossdef><para>All system configuration files are under
	directory <filename>/etc/</filename>.</para></glossdef>
      </glossentry>
      <glossentry id="editor">
	<glossterm>editor <replaceable>files</replaceable></glossterm>
	<glossdef><para>Default text editor.  May be
	<command>nano</command>, <command>emacs</command>,
	<command>vi</command>,
	<command>joe</command>.</para></glossdef>
      </glossentry>
      <glossentry id="cups">
	<glossterm><ulink url="http://localhost:631">CUPS</ulink> at
	<filename>http://hostname:631</filename></glossterm>
	<glossdef><para>Browser interface to printing
	system.</para></glossdef>
      </glossentry>
      <glossentry id="dpkg-reconfigure">
	<glossterm>dpkg-reconfigure
	<replaceable>package-name</replaceable></glossterm>
	<glossdef><para>Reconfigure a package, e.g. <replaceable>keyboard-configuration</replaceable>
	(keyboard), <replaceable>locales</replaceable> (localization).</para></glossdef>
      </glossentry>
      <glossentry id="update-alternatives">
	<glossterm>update-alternatives
	<replaceable>options</replaceable></glossterm>
	<glossdef><para>Manage command alternatives.</para></glossdef>
      </glossentry>
      <glossentry id="update-grub">
	<glossterm>update-grub</glossterm>
	<glossdef><para>After changing
	<filename>/etc/default/grub</filename>.</para></glossdef>
      </glossentry>
    </glosslist>
  </section>
  <section id="daemons">
    <title>Daemons and System</title>
    <glosslist>
      <glossentry id="restart">
	<glossterm><filename>systemctl restart 
	<replaceable>name</replaceable>.service</filename></glossterm>
	<glossdef><para>Restart a service, system
	daemon.</para></glossdef>
      </glossentry>
      <glossentry id="stop">
	<glossterm><filename>systemctl stop 
	<replaceable>name</replaceable>.service</filename></glossterm>
	<glossdef><para>Stop a service, system
	daemon.</para></glossdef>
      </glossentry>
      <glossentry id="start">
	<glossterm><filename>systemctl start 
	<replaceable>name</replaceable>.service</filename></glossterm>
	<glossdef><para>Start a service, system
	daemon.</para></glossdef>
      </glossentry>
      <glossentry id="halt">
	<glossterm>systemctl halt</glossterm>
	<glossdef><para>Halts system.</para></glossdef>
      </glossentry>
      <glossentry id="reboot">
	<glossterm>systemctl reboot</glossterm>
	<glossdef><para>Reboots system.</para></glossdef>
      </glossentry>
      <glossentry id="poweroff">
	<glossterm>systemctl poweroff</glossterm>
	<glossdef><para>Shuts down system.</para></glossdef>
      </glossentry>
      <glossentry id="suspend">
	<glossterm>systemctl suspend</glossterm>
	<glossdef><para>Suspends system.</para></glossdef>
      </glossentry>
      <glossentry id="hibernate">
	<glossterm>systemctl hibernate</glossterm>
	<glossdef><para>Hibernates system.</para></glossdef>
      </glossentry>
      <glossentry id="var-log">
	<glossterm><filename>/var/log/</filename></glossterm>
	<glossdef><para>All log files are under this
	directory.</para></glossdef>
      </glossentry>
      <glossentry id="etc-default">
	<glossterm><filename>/etc/default/</filename></glossterm>
	<glossdef><para>Default values for many daemons and
	services.</para></glossdef>
      </glossentry>
    </glosslist>
  </section>
  <section id="shell-commands">
    <title>Important Shell Commands</title>
    <glosslist>
      <glossentry id="cat">
	<glossterm>cat <replaceable>files</replaceable></glossterm>
	<glossdef><para>Print files to screen.</para></glossdef>
      </glossentry>
      <glossentry id="cd">
	<glossterm>cd <replaceable>directory</replaceable></glossterm>
	<glossdef><para>Change to directory.</para></glossdef>
      </glossentry>
      <glossentry id="cp">
	<glossterm>cp <replaceable>files</replaceable>
	<replaceable>dest</replaceable></glossterm>
	<glossdef><para>Copy files and directories.</para></glossdef>
      </glossentry>
      <glossentry id="echo">
	<glossterm>echo <replaceable>string</replaceable></glossterm>
	<glossdef><para>Echo string to screen.</para></glossdef>
      </glossentry>
      <glossentry id="gzip">
	<glossterm>gzip, bzip2, xz
	<optional><filename>-d</filename></optional>
	<replaceable>files</replaceable></glossterm>
	<glossdef><para>Compress, uncompress files.</para></glossdef>
      </glossentry>
      <glossentry id="pager">
	<glossterm>pager <replaceable>files</replaceable></glossterm>
	<glossdef><para>Show contents of files.</para></glossdef>
      </glossentry>
      <glossentry id="ls">
	<glossterm>ls
	<optional><replaceable>files</replaceable></optional></glossterm>
	<glossdef><para>List files.</para></glossdef>
      </glossentry>
      <glossentry id="mkdir">
	<glossterm>mkdir
	<replaceable>directory-names</replaceable></glossterm>
	<glossdef><para>Create directories.</para></glossdef>
      </glossentry>
      <glossentry id="mv">
	<glossterm>mv <replaceable>file1</replaceable>
	<replaceable>file2</replaceable></glossterm>
	<glossdef><para>Move, rename files.</para></glossdef>
      </glossentry>
      <glossentry id="rm">
	<glossterm>rm <replaceable>files</replaceable></glossterm>
	<glossdef><para>Remove files.</para></glossdef>
      </glossentry>
      <glossentry id="rmdir">
	<glossterm>rmdir <replaceable>dirs</replaceable></glossterm>
	<glossdef><para>Remove empty directories.</para></glossdef>
      </glossentry>
      <glossentry id="tar">
	<glossterm>tar
	<optional>c</optional><optional>x</optional><optional>t</optional><optional>z</optional><optional>j</optional><optional>J</optional>
	-f <replaceable>file</replaceable>.tar 
	<optional><replaceable>files</replaceable></optional></glossterm>
	<glossdef><para>Create (c), extract (x), list table of (t)
	archive file, <emphasis>z</emphasis> for <filename>.gz</filename>,
	<emphasis>j</emphasis> for
	<filename>.bz2</filename>, <emphasis>J</emphasis> for
	<filename>.xz</filename>.</para></glossdef>
      </glossentry>
      <glossentry id="find">
	<glossterm>find <replaceable>directories
	expressions</replaceable></glossterm>
	<glossdef><para>Find files like <literal>-name
	<replaceable>name</replaceable></literal> or <literal>-size
	<replaceable>+1000</replaceable></literal>,
	etc.</para></glossdef>
      </glossentry>
      <glossentry id="grep">
	<glossterm>grep <replaceable>search-string</replaceable>
	<replaceable>files</replaceable></glossterm>
	<glossdef><para>Find search-string in files.</para></glossdef>
      </glossentry>
      <glossentry id="ln">
	<glossterm>ln -s <replaceable>file</replaceable>
	<replaceable>link</replaceable></glossterm>
	<glossdef><para>Create a symbolic link to a
	file.</para></glossdef>
      </glossentry>
      <glossentry id="ps">
	<glossterm>ps
	<optional><replaceable>options</replaceable></optional></glossterm>
	<glossdef><para>Show current processes.</para></glossdef>
      </glossentry>
      <glossentry id="kill">
	<glossterm>kill
	<optional><replaceable>-9</replaceable></optional>
	<replaceable>PID</replaceable></glossterm>
	<glossdef><para>Send signal to process (e.g. terminate
	it). Use <command>ps</command> for PID.</para></glossdef>
      </glossentry>
      <glossentry id="su">
	<glossterm>su -
	<optional><replaceable>username</replaceable></optional></glossterm>
	<glossdef><para>Become another user,
	e.g. <filename>root</filename>.</para></glossdef>
      </glossentry>
      <glossentry id="sudo">
	<glossterm>sudo <replaceable>command</replaceable></glossterm>
	<glossdef><para>Execute a command as <filename>root</filename>
	as normal user, see
	<filename>/etc/sudoers</filename>.</para></glossdef>
      </glossentry>
      <glossentry id="gt">
	<glossterm><replaceable>command</replaceable>
	<filename>&gt;</filename>
	<replaceable>file</replaceable></glossterm>
	<glossdef><para>Overwrite file with output of
	command.</para></glossdef>
      </glossentry>
      <glossentry id="gtgt">
	<glossterm><replaceable>command</replaceable>
	<filename>&gt;&gt;</filename>
	<replaceable>file</replaceable></glossterm>
	<glossdef><para>Append output of command to
	file.</para></glossdef>
      </glossentry>
      <glossentry id="pipe">
	<glossterm><replaceable>cmd1</replaceable>
	<filename>|</filename>
	<replaceable>cmd2</replaceable></glossterm>
	<glossdef><para>Use output of command 1 as input of command
	2.</para></glossdef>
      </glossentry>
      <glossentry id="lt">
	<glossterm><replaceable>command</replaceable>
	<filename>&lt;</filename>
	<replaceable>file</replaceable></glossterm>
	<glossdef><para>Use file as input for
	command.</para></glossdef>
      </glossentry>
    </glosslist>
  </section>
  <section id="apt">
    <title>APT</title>
    <glosslist>
      <glossentry id="apt-update">
	<glossterm>apt update</glossterm>
	<glossdef><para>Update packages listings from package
	repositories as listed in
	<filename>/etc/apt/sources.list</filename>. Required whenever
	that file or the contents of the repositories
	change.</para></glossdef>
      </glossentry>
      <glossentry id="apt-search">
	<glossterm>apt search
	<replaceable>search-string</replaceable></glossterm>
	<glossdef><para>Search packages and descriptions for
	<replaceable>search-string</replaceable>.</para></glossdef>
      </glossentry>
      <glossentry id="apt-list-a">
	<glossterm>apt list -a
	<replaceable>package-name</replaceable></glossterm>
	<glossdef><para>Show versions and archive areas of available
	packages.</para></glossdef>
      </glossentry>
      <glossentry id="apt-show-a">
	<glossterm>apt show -a
	<replaceable>package-name</replaceable></glossterm>
	<glossdef><para>Show package information
	incl. description.</para></glossdef>
      </glossentry>
      <glossentry id="apt-install">
	<glossterm>apt install
	<replaceable>package-names</replaceable></glossterm>
	<glossdef><para>Install packages from repositories with all
	dependencies.</para></glossdef>
      </glossentry>
      <glossentry id="apt-upgrade">
	<glossterm>apt upgrade</glossterm>
	<glossdef><para>Install newest versions of all packages
	currently installed.</para></glossdef>
      </glossentry>
      <glossentry id="apt-full-upgrade">
	<glossterm>apt full-upgrade</glossterm>
	<glossdef><para>Like <command>apt upgrade</command>, but
	with advanced conflict resolution.</para></glossdef>
      </glossentry>
      <glossentry id="apt-remove">
	<glossterm>apt remove
	<replaceable>package-names</replaceable></glossterm>
	<glossdef><para>Remove packages.</para></glossdef>
      </glossentry>
      <glossentry id="apt-autoremove">
	<glossterm>apt autoremove</glossterm>
	<glossdef><para>Remove packages that no other packages depend
	on.</para></glossdef>
      </glossentry>
      <glossentry id="apt-depends">
	<glossterm>apt depends
	<replaceable>package-name</replaceable></glossterm>
	<glossdef><para>List all packages needed by the one
	given.</para></glossdef>
      </glossentry>
      <glossentry id="apt-rdepends">
	<glossterm>apt rdepends
	<replaceable>package-name</replaceable></glossterm>
	<glossdef><para>List all packages that need the one
	given.</para></glossdef>
      </glossentry>
      <glossentry id="apt-file-update">
	<glossterm>apt-file update</glossterm>
	<glossdef><para>Update content listings from package
	repositories, see <command>apt
	update</command>.</para></glossdef>
      </glossentry>
      <glossentry id="apt-file-search">
	<glossterm>apt-file search
	<replaceable>file-name</replaceable></glossterm>
	<glossdef><para>Search packages for file.</para></glossdef>
      </glossentry>
      <glossentry id="apt-file-list">
	<glossterm>apt-file list
	<replaceable>package-name</replaceable></glossterm>
	<glossdef><para>List contents of a package.</para></glossdef>
      </glossentry>
      <glossentry id="aptitude">
	<glossterm>aptitude</glossterm>
	<glossdef><para>Console interface to APT, needs
	<filename>aptitude</filename>.</para></glossdef>
      </glossentry>
      <glossentry id="synaptic">
	<glossterm>synaptic</glossterm>
	<glossdef><para>GUI interface to APT, needs
	<filename>synaptic</filename>.</para></glossdef>
      </glossentry>
    </glosslist>
  </section>
  <section id="dpkg">
    <title>Dpkg</title>
    <glosslist>
      <glossentry id="dpkg-list">
	<glossterm>dpkg -l
	<optional><replaceable>names</replaceable></optional></glossterm>
	<glossdef><para>List packages.</para></glossdef>
      </glossentry>
      <glossentry id="dpkg-info">
	<glossterm>dpkg -I
	<replaceable>pkg</replaceable>.deb</glossterm>
	<glossdef><para>Show package information.</para></glossdef>
      </glossentry>
      <glossentry id="dpkg-contents">
	<glossterm>dpkg -c
	<replaceable>pkg</replaceable>.deb</glossterm>
	<glossdef><para>List contents of package
	file.</para></glossdef>
      </glossentry>
      <glossentry id="dpkg-search">
	<glossterm>dpkg -S
	<replaceable>filename</replaceable></glossterm>
	<glossdef><para>Show which package a file belongs
	to.</para></glossdef>
      </glossentry>
      <glossentry id="dpkg-install">
	<glossterm>dpkg -i
	<replaceable>pkg</replaceable>.deb</glossterm>
	<glossdef><para>Install package files.</para></glossdef>
      </glossentry>
      <glossentry id="dpkg-verify">
	<glossterm>dpkg -V
	<optional><replaceable>package-names</replaceable></optional></glossterm>
	<glossdef><para>Audit check sums of installed packages.</para></glossdef>
      </glossentry>
      <glossentry id="dpkg-divert">
	<glossterm>dpkg-divert <optional>options</optional>
	<replaceable>file</replaceable></glossterm>
	<glossdef><para>Override a package&apos;s version of a
	file.</para></glossdef>
      </glossentry>
      <glossentry id="dpkg-compare-versions">
	<glossterm>dpkg <filename>--compare- versions </filename>
	<replaceable>v1</replaceable> gt
	<replaceable>v2</replaceable></glossterm>
	<glossdef><para>Compare version numbers; view results with
	<command>echo $?</command>.</para></glossdef>
      </glossentry>
      <glossentry id="dpkg-query">
	<glossterm>dpkg-query -W &#x00A0;&#x00A0;&#x00A0;&#x00A0;
	<filename>--showformat</filename>=<replaceable> format</replaceable></glossterm>
	<glossdef><para>Query installed packages, format
	e.g. <screen>'${Package}</screen> <screen>${Version}</screen>
	<screen>${Installed-Size}\n'</screen></para></glossdef>
      </glossentry>
      <glossentry id="dpkg-get-selections">
	<glossterm>dpkg <filename>--get-selections</filename> &gt;
	<replaceable>file</replaceable></glossterm>
	<glossdef><para>Write package selections to
	file.</para></glossdef>
      </glossentry>
      <glossentry id="dpkg-set-selections">
	<glossterm>dpkg <filename>--set-selections</filename> &lt;
	<replaceable>file</replaceable></glossterm>
	<glossdef><para>Set package selections from
	file.</para></glossdef>
      </glossentry>
    </glosslist>
  </section>
  <section id="network">
    <title>The Network</title>
    <glosslist>
      <glossentry id="etc-network-interfaces">
       <glossterm><filename>/etc/network/interfaces</filename></glossterm>
       <glossdef><para>Interface configuration (if not controlled
	via network-manager).</para></glossdef>
      </glossentry>
      <glossentry id="ifupdown">
	<glossterm>if <optional>up</optional><optional>down</optional>
	<replaceable>device</replaceable></glossterm>
	<glossdef><para>Start, stop network interfaces according to the
	file above.</para></glossdef>
      </glossentry>
      <glossentry id="sbin-ip">
	<glossterm>ip</glossterm>
	<glossdef><para>Show and manipulate network interfaces and
	routing, needs <filename>iproute2</filename>.</para></glossdef>
      </glossentry>
      <glossentry id="ssh">
	<glossterm>ssh -X
	<replaceable>user@host</replaceable></glossterm>
	<glossdef><para>Login at another machine.</para></glossdef>
      </glossentry>
      <glossentry id="scp">
	<glossterm>scp <replaceable>files</replaceable>
	<replaceable>user@host:path</replaceable></glossterm>
	<glossdef><para>Copy files to other machine (and vice
	versa).</para></glossdef>
      </glossentry>
    </glosslist>
  </section>
</article>