diff --git a/.gitignore b/.gitignore index b641592b9..0aa8aea3a 100644 --- a/.gitignore +++ b/.gitignore @@ -33,7 +33,4 @@ i3-nagbar/i3-nagbar i3-msg/i3-msg i3-config-wizard/i3-config-wizard libi3/libi3.a -docs/*.html -docs/*.aux -docs/*.out docs/*.pdf diff --git a/debian/control b/debian/control index 1119d69d3..ddbe4fc37 100644 --- a/debian/control +++ b/debian/control @@ -3,7 +3,7 @@ Section: utils Priority: extra Maintainer: Michael Stapelberg DM-Upload-Allowed: yes -Build-Depends: debhelper (>= 7.0.50~), libx11-dev, libxcb-util0-dev (>= 0.3.8), libxcb-keysyms1-dev, libxcb-xinerama0-dev (>= 1.1), libxcb-randr0-dev, libxcb-icccm4-dev, libxcursor-dev, asciidoc (>= 8.4.4), xmlto, docbook-xml, pkg-config, libev-dev, flex, bison, libyajl-dev, texlive-latex-base, texlive-latex-recommended, texlive-latex-extra, libpcre3-dev, libstartup-notification0-dev (>= 0.10) +Build-Depends: debhelper (>= 7.0.50~), libx11-dev, libxcb-util0-dev (>= 0.3.8), libxcb-keysyms1-dev, libxcb-xinerama0-dev (>= 1.1), libxcb-randr0-dev, libxcb-icccm4-dev, libxcursor-dev, asciidoc (>= 8.4.4), xmlto, docbook-xml, pkg-config, libev-dev, flex, bison, libyajl-dev, libpcre3-dev, libstartup-notification0-dev (>= 0.10) Standards-Version: 3.9.2 Homepage: http://i3wm.org/ diff --git a/debian/i3-wm.docs b/debian/i3-wm.docs index 9f7ed2c6c..a14b8152c 100644 --- a/debian/i3-wm.docs +++ b/debian/i3-wm.docs @@ -25,3 +25,6 @@ docs/tree-shot1.png docs/tree-shot2.png docs/tree-shot3.png docs/tree-shot4.png +docs/refcard.html +docs/refcard_style.css +docs/logo-30.png diff --git a/docs/Makefile b/docs/Makefile index 6584ac062..fc41236f2 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -1,7 +1,9 @@ # To pass additional parameters for asciidoc ASCIIDOC=asciidoc -all: hacking-howto.html debugging.html debugging-release-version.html userguide.html ipc.html multi-monitor.html wsbar.html refcard.pdf testsuite.html i3bar-protocol.html +ASCIIDOC_TARGETS:=hacking-howto.html debugging.html debugging-release-version.html userguide.html ipc.html multi-monitor.html wsbar.html testsuite.html i3bar-protocol.html + +all: ${ASCIIDOC_TARGETS} hacking-howto.html: hacking-howto $(ASCIIDOC) -a toc -n $< @@ -30,8 +32,5 @@ multi-monitor.html: multi-monitor wsbar.html: wsbar $(ASCIIDOC) -a toc -n $< -refcard.pdf: refcard.tex - pdflatex refcard.tex && pdflatex refcard.tex - clean: - find . -regex ".*\.\(aux\|out\|log\|toc\|bm\|pdf\|dvi\|log\|html\)" -exec rm '{}' \; + rm -f ${ASCIIDOC_TARGETS} diff --git a/docs/logo-30.png b/docs/logo-30.png new file mode 100644 index 000000000..207b88886 Binary files /dev/null and b/docs/logo-30.png differ diff --git a/docs/refcard.html b/docs/refcard.html new file mode 100644 index 000000000..a4427f4f2 --- /dev/null +++ b/docs/refcard.html @@ -0,0 +1,186 @@ + + + + + i3 Reference Card + + + + +
+
+ +

i3 Reference Card

+ http://i3wm.org/docs/userguide.html +

+ Throughout this guide, the i3 logo will be used to refer to the configured modifier. + This is the key (Mod1) by default, + with super/ (Mod4) being a popular alternative. +

+
+ +
+

Basics

+ + + + + + +
+ + open new terminal + +
+j + focus left + +
+k + focus down + +
+l + focus up + +
+; + focus right +
+
+ + +
+

Changing the container layout

+ + + + +
+e + default + +
+s + stacking + +
+w + tabbed +
+
+ +
+ +
+

Fullscreen mode

+ + +
+f + toggle fullscreen +
+
+ + +
+

Opening other applications

+ + +
+d + open application (with dmenu) +
+ + +
+

Closing windows

+ + +
++ q + kill a window +
+
+ + +
+

Using workspaces

+ + +
+1–9 + switch to another workspace +
+
+ + +
+

Moving windows to workspaces

+ + +
+ + 1–9 + move a window to another workspace +
+
+ +
+ +
+

Resizing

+

Look at “Resizing containers / windows” section of the user guide.

+
+ + +
+

Restart / Exit

+ + + +
+ + r + restart i3 inplace + +
+ + e + + exit i3 +
+ + +
+

Floating

+ + + +
+ + + toggle floating + +
+ + drag floating +
+
+ + + +

+ Permission is granted to copy, distribute and/or modify this document provided + the copyright notice and this permission notice are preserved on all copies. +

+
+ diff --git a/docs/refcard.tex b/docs/refcard.tex deleted file mode 100644 index 6ded01e92..000000000 --- a/docs/refcard.tex +++ /dev/null @@ -1,107 +0,0 @@ -\documentclass[10pt,a4,landscape]{article} - -% \usepackage[cam,a4,center,info,]{crop} % frame -\usepackage[height=20cm,width=25.7cm,noheadfoot,landscape]{geometry} % A4 - 210297 mm - -\usepackage[T1]{fontenc} -\usepackage{multicol} -\usepackage{color} -\usepackage{url} -\usepackage{lastpage} - -\usepackage{hyperref} -\hypersetup{ - pdftitle={i3 Reference Card}, - pdfauthor={\textcopyright\ Zeus Panchenko}, - pdfkeywords={i3, refcard}, - pdfsubject={based on http://i3wm.org/docs/userguide.html}, - pdfpagemode={FullScreen}} - -\definecolor{lightgray}{gray}{0.7} - -\pagestyle{empty} - -\setlength{\parindent}{0in} -\setlength{\columnseprule}{0.5pt} -\setlength{\columnsep}{20pt} - -\newcommand{\RefCardTitle}[2] -{\centering{\Large{\textbf{i3 Reference Card (#1/#2)\\ - {\scriptsize{\url{http://i3wm.org/docs/userguide.html}}}}}} - \vspace{1mm}} - - -\newcommand{\RefCardSec}[1] {\vspace{2mm} \raggedright {\vspace{0.5mm} - \colorbox{lightgray} {\makebox[0.31\textwidth][l] - {\Large{\textsc{\textsf{\textbf{\color{black}#1}}}}}} - \vspace{0.5mm}}} - -\newcommand{\RefCardRow}[2] {\normalsize{\textbf{\texttt{#1}}} - \hspace{\stretch{1}} \raggedleft{\small{\textnormal{#2}}} \\} - -\begin{document} - -\centering - -\begin{multicols}{3} - \RefCardTitle{\thepage}{\pageref{LastPage}} - - \RefCardSec{Moving around} - - \RefCardRow{Mod1+Enter}{open new terminal} - \RefCardRow{Mod1+j}{focus (left)} - \RefCardRow{Mod1+k}{focus (down)} - \RefCardRow{Mod1+l}{focus (up)} - \RefCardRow{Mod1+;}{focus (right)} - \RefCardRow{Mod1+Shift+j}{move window (left)} - \RefCardRow{Mod1+Shift+k}{move window (down)} - \RefCardRow{Mod1+Shift+l}{move window (up)} - \RefCardRow{Mod1+Shift+;}{move window (right)} - \RefCardRow{Mod1+Control+j}{snap (left)} - \RefCardRow{Mod1+Control+k}{snap (down)} - \RefCardRow{Mod1+Control+l}{snap (up)} - \RefCardRow{Mod1+Control+;}{snap (right)} - \RefCardRow{Mod1+Shift+q}{kill a window} - \RefCardRow{Mod1+Shift+}{move a window to another workspace} - - - \RefCardSec{Changing container modes} - - \RefCardRow{Mod1+e}{default} - \RefCardRow{Mod1+h}{stacking} - \RefCardRow{Mod1+w}{tabbed} - \RefCardRow{Mod1+Shift+f}{global fullscreen} - \RefCardRow{Mod1+f}{toggle fullscreen} - \RefCardRow{Mod1+Shift+Space}{toggle floating} - \RefCardRow{Mod1+}{drag floating} - - \RefCardSec{Opening other applications} - - \RefCardRow{Mod1+v}{open application launcher (dmenu)} - - \RefCardSec{Using workspaces} - - \RefCardRow{Mod1+}{switch to another workspace} - - \RefCardSec{Restarting i3 inplace} - - \RefCardRow{Mod1+Shift+r}{restart i3 inplace} - - \RefCardSec{Exiting i3} - - \RefCardRow{Mod1+Shift+e}{exit i3} - - \vspace{1cm} - \tiny{ - \begin{center} - Copyright \copyright 2009, Michael Stapelberg \\ - All rights reserved. \\ - Designed by Zeus Panchenko - \end{center} - Permission is granted to copy, distribute and/or modify this - document provided the copyright notice and this permission - notice are preserved on all copies.} - -\end{multicols} - -\end{document}