Skip to content

Commit

Permalink
Fixes in docu. German manpage.
Browse files Browse the repository at this point in the history
  • Loading branch information
vaeth committed Jun 6, 2020
1 parent 5091dd3 commit 16da995
Show file tree
Hide file tree
Showing 7 changed files with 205 additions and 30 deletions.
8 changes: 8 additions & 0 deletions ChangeLog
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# ChangeLog for zram-init:

*zram-init-10.1:
Mattéo Rossillol‑‑Laruelle <beatussum at protonmail.com>:
- Fixes in docu

Martin Väth <martin at mvath.de>:
- Fixes in docu
- German manpage

*zram-init-10.0:
Mattéo Rossillol‑‑Laruelle <beatussum at protonmail.com>:
- XFS support
Expand Down
15 changes: 12 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ DESTDIR ?=

BINDIR ?= $(DESTDIR)$(PREFIX)/sbin
MODPROBEDIR ?= $(DESTDIR)$(SYSCONFDIR)/modprobe.d
MANDIR ?= $(DESTDIR)$(PREFIX)/share/man/man8
MANDIR ?= $(DESTDIR)$(PREFIX)/share/man
MANSUBDIR ?= man8
MANI18NAPP ?=
MODIR ?= $(DESTDIR)$(PREFIX)/share/locale
COMP_ZSHDIR ?= $(DESTDIR)$(PREFIX)/share/zsh/site-functions
SYSTEMDDIR ?= $(DESTDIR)$(PREFIX)/lib/systemd/system
Expand All @@ -17,6 +19,8 @@ INITDIR ?= $(DESTDIR)$(SYSCONFDIR)/init.d

PO ?= i18n/de.po i18n/fr.po

MANI18N ?= de fr

GETTEXT ?= TRUE
MODIFY_SHEBANG ?= TRUE
MODPROBED ?= TRUE
Expand Down Expand Up @@ -80,8 +84,13 @@ ifeq ($(MODPROBED), TRUE)
$(INSTALL_DATA) modprobe.d/zram.conf '$(MODPROBEDIR)/zram.conf'
endif
ifeq ($(MANPAGE), TRUE)
@echo 'Installing the man page…'
$(INSTALL_DATA) 'man/$(EXENAME).8' '$(MANDIR)/$(EXENAME).8'
@echo 'Installing the man pages…'
$(INSTALL_DATA) 'man/$(EXENAME).8' '$(MANDIR)/$(MANSUBDIR)/$(EXENAME).8'
for i in $(MANI18N); do \
! test -r 'man/$(EXENAME).$$i.8' || \
$(INSTALL_DATA) 'man/$(EXENAME).$$i.8' \
'$(MANDIR)/$$i$(MANI18NAPP)/$(MANSUBDIR)/$(EXENAME).8' ; \
done
endif
ifeq ($(GETTEXT), TRUE)
@echo 'Installing the Machine Object files…'
Expand Down
28 changes: 14 additions & 14 deletions i18n/de.po
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@
# Martin V"ath <martin@mvath.de>
msgid ""
msgstr ""
"Project-Id-Version: zram-init 9.1\n"
"Project-Id-Version: zram-init\n"
"Report-Msgid-Bugs-To: Martin V\"ath <martin@mvath.de>\n"
"POT-Creation-Date: 2020-06-01 13:19+0200\n"
"PO-Revision-Date: 2020-06-01 13:20+0200\n"
"PO-Revision-Date: 2020-06-06 09:45+0200\n"
"Last-Translator: Martin V\"ath <martin@mvath.de>\n"
"Language-Team: German\n"
"Language: de\n"
Expand Down Expand Up @@ -85,30 +85,30 @@ msgstr ""
"(bzw. hängt es als VERZEICHNIS ein).\n"
"GRÖSSE ist die maximale Größe in Megabytes.\n"
"Zum Aushängen/Freigeben des zRAM-Devices kann man SIZE=0 benutzen.\n"
"By Benutzung von \"write\" (oder etwas anderem, das mit \"w\" beginnt) wird ein\n"
"Bei Benutzung von \"write\" (oder etwas anderem, das mit \"w\" beginnt) wird ein\n"
"idle writeback erzwungen. (Das ist nur nach vorheriger Initialisierung mit \"-w\"\n"
"oder \"-W LIMIT\" sinnvoll.)\n"
"Falls VERZEICHNIS ein - ist, so wird nur ein Dateisystem in /dev/zram$DEV\n"
"erzeugt (bzw. falls GRÖSSE 0 ist, wird das Device wird gelöscht), aber es wird\n"
"erzeugt (bzw. falls GRÖSSE 0 ist, wird das Device gelöscht), aber es wird\n"
"nicht eingehängt. (Die Optionen \"-o\", \"-c\", \"-m\" und \"-T\" haben in\n"
"diesem Fall natürlich keine Wirkung.)\n"
"Letzteres kann sinnvoll sein, wenn z.B. für Btrfs später mehrere Devices\n"
"gemeinsam eingehängt werden sollen.\n"
"Es gibt die folgenden Optionen.\n"
"Ein leeres Argument ist gleichbedeutend mit dem Weglassen der Option.\n"
"-d DEV Nutze zRAM device DEV. Wenn ncht angegeben wird DEV=0 genommen.\n"
" Der selbe Wert muss auch zumAushängen (GRÖSSE=0) benutzt werden!\n"
"-D NUM Wenn modprobe benutzt werden muss, fordere NUM devices an. Dies\n"
" ist nicht empfohlen. Empfohlen ist statt dessen die Nutzung von\n"
" /etc/modprobe.d/zram.conf mit der Zeile\n"
"-d DEV Nutzt zRAM device DEV. Wenn ncht angegeben wird DEV=0 genommen.\n"
" Der selbe Wert muss auch zum Aushängen (GRÖSSE=0) benutzt werden!\n"
"-D NUM Wenn modprobe benutzt werden muss, werden NUM Devices angefordert.\n"
" Dies ist nicht empfohlen. Empfohlen ist statt dessen die Nutzung\n"
" von /etc/modprobe.d/zram.conf mit der Zeile\n"
" \"options zram num_devices=NUM\"\n"
"-s NUM Nutzt bis zu NUM paralleler Kompressionsströme für das Device.\n"
"-S MAX Nutzt maximal MAX Megabytes unkompromierten Speicher für das\n"
" Device.\n"
"-b DEV Nutzt DEV als Backing Device.\n"
"-I Falls mit \"-b DEV\" kombiniert, speichert unkomprimierbare Seiten\n"
" in das Backing Device.\n"
"-w Falls mit \"-b DEV\" kombiniert, erlaubt Idle Writeback für das\n"
"-w Falls mit \"-b DEV\" kombiniert, ermöglicht Idle Writeback für das\n"
" Backing Device.\n"
"-W LIMIT Wie \"-w\", aber zusätzlich wird writeback_limit auf LIMIT * 4kB\n"
" gesetzt.\n"
Expand All @@ -120,22 +120,22 @@ msgstr ""
"-o OPTS Falls angegeben, hängt VERZEICHNIS mit \"-o OPTS\" ein.\n"
"-p PRIO Nutzt Priorität PRIO für das Swap-Device.\n"
" Falls nicht angegeben, wird PRIO=16383 genommen.\n"
" Mit PRIO=- wird die Default-Priorität (-1) beibehalten.\n"
" Mit PRIO=- wird die voreingestellte Priorität (-1) beibehalten.\n"
"-t TYP Nutzt ein Dateisystem vom Typ TYP, wenn VERZEICHNIS angegeben ist.\n"
" Mögliche Werte für TYP sind ext2, ext4, btrfs und xfs\n"
" Wenn nicht angegeben wird TYPE=ext4 genommen.\n"
" Wenn nicht angegeben, wird TYPE=ext4 genommen.\n"
"-i IRATIO Wenn angegeben, wird das Bytes/Inodes-Verhältnis im Dateisystem\n"
" überschrieben (ext2, ext4).\n"
"-N INODES Wenn angegeben, wird die Inode-Zahl überschrieben (ext2, ext4).\n"
"-L LABEL Nimmt Label LABEL für das neue Dateisystem.\n"
"-U UUID Nimmt Uuid UUID für das neue Dateisystem.\n"
"-T Wenn angegeben wird das Discard (TRIM) Feature von ext4/swap nicht\n"
"-T Wenn angegeben, wird das Discard (TRIM) Feature von ext4/swap nicht\n"
" genutzt. Diese Option ist für Linux-3.14 oder früher, oder wenn ein\n"
" kleiner Geschwindigkeitsgewinn auf Kosten von möglicherweise viel\n"
" Speicher gewünscht wird.\n"
"-l Vermeidet die Benutzung von zramctl, selbst wenn verfügbar.\n"
"-k Versucht nicht, ein vorheriges ZRAM unter diesem Device auszuhängen\n"
" oder zu un-initialisieren.\n"
" oder zu Deinitialisieren.\n"
"\n"
"Falls push.sh im $PATH ist, kann man folgende sukzessive Optionen nutzen:\n"
"-K ARG Übergibt ARG an den zugehörigen Aufruf von mkswap bzw. mkfs.*.\n"
Expand Down
2 changes: 1 addition & 1 deletion i18n/fr.po
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# Mattéo Rossillol‑‑Laruelle <beatussum@protonmail.com>, 2020.
msgid ""
msgstr ""
"Project-Id-Version: zram-init 9.1\n"
"Project-Id-Version: zram-init\n"
"Report-Msgid-Bugs-To: Martin V\"ath <martin@mvath.de>\n"
"POT-Creation-Date: 2020-06-01 13:19+0200\n"
"PO-Revision-Date: 2020-06-01 13:43+0200\n"
Expand Down
29 changes: 18 additions & 11 deletions man/zram-init.8
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH ZRAM-INIT "8" "January 2020" "zram-init" "System Administration"
.TH ZRAM-INIT "8" "June 2020" "zram-init" "System Administration"
.\" {{{ SEE ALSO
.SH "NAME"
\fBzram-init\fR \- Scripts to support compressed swap devices or ramdisks with zram
Expand Down Expand Up @@ -32,6 +32,8 @@ An empty argument means the same as if the option is not specified.
.TP
.BR "\-d " \fIDEV
Use zram device /dev/zram\fIDEV\fR. Default is 0 (/dev/zram0).
.br
Make sure to use the matching value for unmounting (\fISIZE\fR=0)!
.TP
.BR "-D " \fINUM
If modprobe needs to be used, require \fINUM\fR devices.
Expand Down Expand Up @@ -90,6 +92,19 @@ Specify the uuid \fIUUID\fR for the new filesystem.
.TP
.B \-T
Do not use the discard (TRIM) feature of ext4/swap.
.br
Use this option with linux-3.14 or earlier or when you want a slight
speed increase at the cost of possibly wasting a lot of memory.
.TP
.BR \-l
Do not use zramctl even if available.
.TP
.BR \-k
Do no attempt to umount/free a previously used zram under this device.
.P
If you have \fBpush.sh\fR in \fB$PATH\fR, you can also use the following
options accumulatively:
.P
.TP
.BR "\-K " \fIARG
Pass \fIARG\fR to the respective mkswap or mkfs.* call.
Expand All @@ -101,17 +116,9 @@ Pass \fIARG\fR to the respective swapon/mount call.
Pass \fIARG\fR to the tune2fs call (ignored unless for ext2 or ext4).
.TP
.BR "\-Z " \fIARG
Pass \fIARG\fR to the zramctl call
.P
Use the following options with linux\-3.14 or earlier or when you want a slight
speed increase at the cost of possibly wasting a lot of memory.
Pass \fIARG\fR to the zramctl call.
.P
.TP
.BR \-l
Do not use zramctl even if available.
.TP
.BR \-k
Do no attempt to umount/free a previously used zram under this device.
Call with \fBLANG=C\fR to disable translations.
.\" }}}

.\" {{{ AUTHORS
Expand Down
151 changes: 151 additions & 0 deletions man/zram-init.de.8
Original file line number Diff line number Diff line change
@@ -0,0 +1,151 @@
.TH ZRAM-INIT "8" "June 2020" "zram-init" "System Administration"
.\" {{{ SEE ALSO
.SH "NAME"
\fBzram-init\fR \- Skripte zur Unterst\(:utzung komprimierter Swap-Devices oder Ramdisks mit zram
.\" }}}

.\" {{{ SYNOPSIS
.SH "\(:UBERSICHT"
.B zram-init
[\fI\,options\/\fR] \fI\,GR\(:OSSE\fR|\fIwrite \/\fR[\fI\,VERZEICHNIS\/\fR]
.\" }}}

.\" {{{ DESCRIPTION
.SH "BESCHREBIUNG"
Initialisiert ein zram-Device und benutzt es als Swap (bzw. h\(:angt es unter \fIVERZEICHNIS\fR ein).
.br
\fIGR\(:OSSE\fR ist der Maximalwert in Megabytes. Zum Aush\(:angen/Freigeben des zram-Devicesevice, kann man \fISIZE=0\fR benutzen.
.br
Bei Benutzung von \fIwrite\fR (oder etwas anderem, das mit \fIw\fR beginnt) wird ein idle writeback erzweungen. (Das ist nur nach vorheriger Initialisierung mit \fB-w\fR bzw. \fB-W\fR \fILIMIT\fR sinnvoll.)
.sp
Falls \fIVERZEICHNIS\fR ein \- ist, so wird nur ein Dateisystem in /dev/zram\fIDEV\fR erzeugt (bzw. falls \fIGR\(:OSSE\fR 0 ist,
wird das Device gel\(:oscht), aber es wird nicht eingeh\(:angt. (Die Optionen \fB\-o\fR \fB\-c\fR \fB\-m\fR und \fB\-T\fR haben in diesem Fall nat\(:urlich keine Wirkung.)
.br
Letzteres kann sinnvoll sein, wenn z.B: f\(:ur Btrfs sp\(:ater mehrere Devices gemeinsam eingeh\(:angt werden sollen.
.br
.\" }}}

.\" {{{ OPTIONS
.SH "OPTIONEN"
Ein leeres Argument ist gleichbedeutend mit dem Weglassen der Option.
.TP
.BR "\-d " \fIDEV
Nutzt zram-Device /dev/zram\fIDEV\fR. Voreinstellung ist 0 (/dev/zram0).
.br
Der selbe Wert muss auch zum Aush\(:angen (\fIGR\(:OSSE\fR=0) benutzt werden!
.TP
.BR "-D " \fINUM
Wenn modprobe benutzt werden muss, werden \fINUM\fR Devices angefordert.
.br
Dies ist nicht empfohlen. Empfohlen ist statt dessen die Nutzung von
\fI\,/etc/modprobe.d/zram.conf\/\fP mit der Zeile
.br
options zram num_devices=\fINUM\fR
.TP
.BR "\-s " \fINUM
Nutzt bis zu \fINUM\fR paralleler Kompressionsstr\(:ome f\(:ur das Device.
.TP
.BR "\-S " \fIMAX
Nutzt maximal \fIMAX\fR Megabytes unkompromierten Speicher f\(:ur das Device.
.TP
.BR "\-b " \fIDEV
Nutzt \fIDEV\fR als Backing Device.
.TP
.BR \-I
Falls mit \fB\-b\fR \fIDEV\fR kombiniert, speichert unkomprimierbare Seiten
in das Backing Device.
.TP
.BR \-w
Falls mit \fB\-b\fR \fIDEV\fR kombiniert, erm\(:oglicht Idle Writeback f\(:ur das
Backing Device.
.TP
.BR "\-W " \fILIMIT
Wie \fB-w\fR, aber zus\(:atzlich wird \fBwriteback_limit\fR auf \fILIMIT\fR * 4kB
gesetzt.
.TP
.BR "\-a 842" | deflate | lz4 | lz4hc | lzo | zstd
Setzt den Kompressions-Algorithmus.
.TP
.BR "\-c " \fIOWNER
Chown auf \fIOWNER\fR (bzw, \fIOWNER:GROUP\fR) nach dem Einh\(:angen.
.TP
.BR "\-m " \fIMODE
Chmod \fIVERZEICHNIS\fR auf \fIMODE\fR after mounting.
.TP
.BR "\-o " \fIOPTS
H\(:angt \fIVERZEICHNIS\fR mit Option \fB\-o\fR \fIOPTS\fR ein.
.TP
.BR "\-p " \fIPRIO
Nutzt Priorit\(:at \fIPRIO\fR f\(:ur das Swap-Device. Voreinstellung ist 16383.
.br
Mit \fIPRIO=\-\fR wird die voreingestellte Priorit\(:at (-1) beibehalten.
.TP
.BR "\-t ext2" | ext4 | btrfs | xfs
Legt Dateisystem-Typ fest, wenn \fIVERZEICHNIS\fR angegeben ist.
Voreinstellung ist \fBext4\fR.
.TP
.BR "\-i " \fIIRATIO
Wenn angegeben, wird das Bytes/Inodes-Verh\(:altnis im Dateisystem \(:uberschrieben
(ext2, ext4).
.TP
.BR "\-N " \fIINODES
Wenn angegeben, wird die Inode-Zahl \(:uberschrieben (ext2, ext4).
.TP
.BR "\-L " \fILABEL
Nimmt Label \fILABEL\fR f\(:ur das neue Dateisystem.
.TP
.BR "\-U " \fIUUID
Nimmt Uuid \fIUUID\fR f\(:ur das neue Dateisystem.
.TP
.B \-T
Wenn angegeben wird das Discard (TRIM) Feature von ext4/swap nicht genutzt.
.br
Diese Option ist f\(:ur linux\-3.14 oder fr\(:uher, oder when ein kleiner
Geschwindigkeitsvorteil auf Kosten von m\(:oglicherweise viel Speicher
gew\(:unscht wird.
.TP
.BR \-l
Vermeidet die Benutzung von zramctl, selbst wenn verf\(:ugbar.
.TP
.BR \-k
Versucht nicht, ein vorheriges ZRAM unter diesem Device auszuh\(:angen oder
zu Deinitialisieren.
.P
Falls \fBpush.sh\fR im \fB$PATH\fR ist, kann man folgende sukzessive
Optionen nutzen:
.P
.TP
.BR "\-K " \fIARG
\(:Ubergibt \fIARG\fR an den zugeh\(:origen Aufruf von mkswap bzw mkfs.*.
.TP
.BR "\-M " \fIARG
\(:Ubergibt \fIARG\fR an den zugeh\(:origen Aufruf von swapon/mount.
.TP
.BR "\-2 " \fIARG
\(:Ubergibt \fIARG\fR an den Aufruf von tune2fs (nur f\(:ur ext2 oder ext4).
.TP
.BR "\-Z " \fIARG
\(:Ubergibt \fIARG\fR an den Aufruf von zramctl.
.P
Aufruf mit \fBLANG=C\fR schaltet die \(:Ubersetzungen aus.
.\" }}}

.\" {{{ AUTHORS
.SH "AUTHORS"
.LP
Martin V\(:ath <martin at mvath.de> (developer, current maintainer)
.\" }}}

.\" {{{ SEE ALSO
.SH "SEE ALSO"
.BR zramctl (8),
.BR mkswap (8),
.BR mke2fs (8),
.BR mkfs.btrfs (8)
.sp
The zram-init homepage
.UR https://github.\:com\:/vaeth\:/zram-init
.UE " provides further information and links."
.\" }}}

.\" vim:set tw=90 expandtab foldenable foldmethod=marker foldlevel=0 :
2 changes: 1 addition & 1 deletion openrc/conf.d/zram-init
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ num_devices=2
# The flags variable specifies the priority (16383 if empty).
# Use "-" in the flags variable for the default priority (-1)
# "/..." The device is mounted on /...
# The flags variable specifies the type (ext2, ext4, btrfs or xfs;
# The flags variable specifies the type (ext2, ext4, btrfs, or xfs;
# default is ext4)
# "-" The filesystem (specified by flags as above) is created in
# /dev/zram$NUM but not mounted
Expand Down

0 comments on commit 16da995

Please sign in to comment.