Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit

Permalink
Merge branch 'beta' of https://github.com/cmames/zramit into beta
Browse files Browse the repository at this point in the history
  • Loading branch information
cmames committed Feb 4, 2021
2 parents 32a9523 + be6a21f commit 5679e11
Showing 1 changed file with 127 additions and 12 deletions.
139 changes: 127 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,29 @@
![Code Grade](https://www.code-inspector.com/project/18173/status/svg)


Zram swap with hibernate for linux system
:uk: Zram swap with hibernate for linux system
> :fr: Zram swap avec prise en charge de l'hibernation pour linux
<a href="https://github.com/cmames/zramit">https://github.com/cmames/zramit</a>

---
### Why?
### Why?

There are dozens of zram swap scripts out there, but most of them are overly
complicated and do things that haven't been neccessary since linux 3.X or have
massive logic errors in their swap size calculations.
Other zram swap scripts don't take care of hibernate or hybrid-sleep and don't
take care of running out of RAM. Zramit do!

> ### Pourquoi?
>
> Il existe des dizaines de scripts de swap zram, mais la plupart sont trop
> compliqués et font des choses non pas nécessaires depuis linux 3.X ou ont
> des erreurs logiques massives dans leurs calculs de taille de swap.
> Les autres scripts de swap zram ne prennent pas en charge l'hibernation ou
> la veille hybride et ne veillent pas à protéger de la pénurie de RAM.
> Zramit le fais!
---
### Installation

Expand All @@ -29,13 +41,35 @@ Download and unzip the zip or tar.gz from [latest zramit release](https://github
or
```
git clone https://github.com/cmames/zramit.git
```
go in the directory created
```
cd zramit
./install.sh
```
and install
```
./zramit.sh --install
```
You can delete the zramit directory after install.

> ### Installation
>
> Téléchargez et décompressez le zip ou le tar.gz depuis [dernière zramit release](https://github.com/cmames/zramit/releases/latest)
>
> ou
> ```
> git clone https://github.com/cmames/zramit.git
> ```
> placez vous dans le répertoire créé
> ```
> cd zramit
> ```
> et installez
> ```
> ./zramit.sh --install
> ```
> Vous pouvez supprimer le répertoire après l'installation
---
### Configure
Expand All @@ -48,10 +82,22 @@ Or with the configure assistant
```
zramit --config
```
> ### Configuration
>
> En modifiant
> ```
> /etc/default/zramit.conf
> ```
>
> Ou en utilisant l'assistant configuration
> ```
> zramit --config
> ```
---
### Status
display status with
Display status with
```
zramit --status
```
Expand All @@ -61,16 +107,38 @@ or dynamic status (auto refresh every second) with
zramit --dstatus
```
> ### Status
>
> Afficher le status avec
> ```
> zramit --status
> ```
>
> ou le status dynamique (rafraichi toutes les secondes) avec
> ```
> zramit --dstatus
> ```
---
### Hibernate, Hybrid-sleep, Suspend
Zramit assure end of zram swap before entering hibernate, and assure start at
resume from hibernate. On resume it move pages from swapfile into zram swap.
resume from hibernate.
Hybrid-sleep is like hibernate to take care in case of power failure.
On suspend, zramit do nothing.
> ### Hibernation, Veille hybride, Veille
>
> Zramit s'assure d'arréter le swap en zram avant d'entrer en hibernation, et
> s'assure de le relancer au retour de l'hibernation.
>
> La veille hybride est comme l'hibernation pour assurer le bon fonctionnement
> en cas de coupure d'alimentation.
>
> Dans la cas de la veille simple, zramit n'a rien besoin de faire de plus.
---
### Usage
Expand All @@ -93,24 +161,71 @@ or
`zramit --restart`
Run `zramctl` to monitor swap compression and real memory usage or run

`zramit --status`
Run `zramctl` during use to monitor swap compression and real memory usage
or run `zramit --status`
You can enable or disable zramit
to disable zramit without uninstalling
`zramit --disable`
to enable zramit after disable
`zramit --disable`
for more details read the man pages
`zramit --enable`
For more details read the man pages
`man zramit`
> ### Utilisation
>
> Zramit.service sera lancé automatiquement après l'installation et à chaque
> démarrage ultérieur. L'installation par défaut crée un périphérique zram qui
> doit utiliser environ la moitié de la mémoire physique lorsqu'elle est
> complètement pleine.
>
> La configuration par défaut utilisant lz4 devrait bien fonctionner pour la
> plupart des gens. lzo peut fournir une utilisation légèrement meilleure de la
> RAM avec un temps légèrement plus important de décompression. zstd devrait
> fournir une meilleure compression que lz* tout en restant modérément rapide
> sur la plupart des machines mais lent sur les anciennes machines. Sur un noyaux
> très moderne, le meilleur choix global est probablement lzo-rle.
>
> Editez `/etc/default/zramit.conf` si vous voulez changer l'algorithme de
> compression ou l'allocation mémoire puis relancez zramit avec
>
> `systemctl restart zramit.service`
>
> ou
>
> `zramit --restart`
>
> Lancez `zramctl` pendant le fonctionnement pour surveiller la compression du swap
> et l'utilisation de la mémoire ou lancez `zramit --status`
>
> Vous pouvez activer ou désactiver zramit
>
> pour désactiver zramit sans désinstaller
>
> `zramit --disable`
>
> pour activer zramit après une désactivation
>
> `zramit --enable`
>
> Pour plus de détail lisez le manuel
>
> `man zramit`
>
---
### Compatibility
This should run on pretty much any recent (4.0+? kernel) Linux system using
systemd.
> ### Compatibilité
>
> Il doit tourner sur les plus récents (4.0+? kernel) systèmes linux utilisant
> systemd

0 comments on commit 5679e11

Please sign in to comment.