[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

[RFR] mksquashfs.fr.8



Bonsoir,

Frédéric Boiteux a écrit une manpages pour le paquet squashfs-tools, et
plus précisément pour la commande mksquashfs. Je l'ai converti au format
*roff (docbook avant la conversion). Serait ce possible de relire cette
page, au niveau syntaxe surtout (c'est ma première page au format *roff)
et éventuellement si vous remarquez quelques petites fautes ;) avant
que j'envoie mon paquet ?

Librement et merci beaucoup d'avance,
-- 
Arnaud Fontaine <arnaud@andesi.org> - http://www.andesi.org/ | GPG
Public Key available on pgp.mit.edu | Fingerprint: D792 B8A5 A567 B001
C342 2613 BDF2 A220 5E36 19D3

.\" This manual page was written by Frédéric Boiteux <fboiteux@calistel.com>
.\" for the Debian system (but may be used by others) using the SquashFS HOWTO
.\" from Artemiy I. Pavlov and squashfs's README file.
.\"
.\" Permission is granted to copy, distribute and/or modify this document 
.\" under the terms of the GNU General Public License, Version 2 any later 
.\" version published by the Free Software Foundation.    
.\" 
.\" On Debian systems, the complete text of the GNU General Public License
.\" can be found in  /usr/share/common-licenses/GPL .

.TH "MKSQUASHFS" 8 "mercredi 6 avril 2005" "Frédéric Boiteux" ""
.SH "NOM"
mksquashfs \- Crée ou modifie un système de fichiers compressé Squash
.SH "SYNOPSIS"
.B mksquashfs\fR [\fB\-version\fR]

.B mksquashfs
.I source
.B ...
.I dest
.B "[options] [\-e liste des rép/fichiers exclus] [\-ef fichier_exclus]"
.SH "DESCRIPTION"
Squashfs est un système de fichiers compressé, accessible en lecture
seulement. Utilisez la commande
.B mksquashfs
pour créer un nouveau système de fichiers de ce type ou pour ajouter
des données à un système existant.

Si on ne donne qu'un seul répertoire source (i.e.
.B mksquashfs
\fIsource sf_résultant\fP), on obtiendra un système de fichiers
constitué du contenu de ce répertoire source.

Si on fournit plusieurs fichier(s) ou répertoire(s) sources,
.B mksquashfs
créera un seul système de fichiers qui contiendra chaque
fichier/répertoire source. Le nom de chaque répertoire obtenu sera
le nom
.I sans chemin d'accès
de chaque répertoire source ; En cas de noms identiques, les doublons
seront renommés en \fIxxx\fP_1, \fIxxx\fP_2, etc.

L'argument 
.I dest
peut être soit un fichier classique, soit un périphérique de type bloc
(comme un disque ou une partition). Si le fichier n'existe pas, il
sera créé ; s'il existe déjà et contient un système de fichiers
Squashfs,
.B mksquashfs
rajoutera les sources données à son contenu actuel, sauf si l'option
.B \-noappend
est précisée.

Il y a nombre d'options contrôlant la compression dans la commande
.B mksquashfs
; En principe, les valeurs par défaut devraient être optimales et ne
devraient être modifiées qu'exceptionnellement !

Les options \fB\-noI\fP,
.B \-noD
et 
.B \-noF
(équivalentes à \fB\-noInodeCompression\fP,
.B \-noDataCompression
et
\fB\-noFragmentCompression\fP) peuvent être utilisées pour obliger
.B mksquashfs
à ne pas comprimer respectivement les i\-noeuds et répertoires, les
blocs de données et les blocs de données fragmentés. Si l'on utilise
ces trois options, on obtient un système de fichiers non comprimé.
.PP
Par défaut, les fichiers contenus dans le système de fichiers résultat
ont le même propriétaire et groupe que les fichiers
sources. Toutefois,
.B mksquashfs
propose certaines options pour modifier ce comportement :
.TP 3
\(bu
Les options
.B \-all\-root
et 
.B \-root\-owned
(synonymes) forcent tous les fichiers du système de fichiers Squashfs
généré à appartenir à root (utilisateur et groupe). Elle permet de
construire un système de fichiers appartenant à root sans avoir un
accès à ce compte sur la machine où on le construit.
.TP
\(bu
L'option 
.B \-force\-uid
.I uid
force tous les fichiers du système de fichiers Squashfs généré à
appartenir à l'utilisateur d'identifiant 
.I uid
donné. Cet identifiant peut être soit un nom (i.e. root), soit un
nombre.
.TP
\(bu
L'option 
.B \-force\-gid
.I gid
force tous les fichiers du système de fichiers Squashfs généré à
appartenir au groupe d'identifiant
.I gid
donné. Cet identifiant peut être soit un nom (i.e. root), soit un
nombre.
.LP
Les options
.B \-e
et 
.B \-ef
permettent de déclarer des fichiers ou répertoires à exclure du
système de fichiers résultat. L'option 
.B \-e
lit les fichiers/répertoires à exclure sur la ligne de commande,
tandis que l'option
.B \-ef
les trouve dans le fichier d'exclusions spécifié contenant un fichier
ou répertoire par ligne. Si le chemin d'un fichier ou répertoire à
exclure est absolu (c'est\-à\-dire débutant par \fI/\fR, \fI../\fR ou
\fI./\fR), il est considéré indépendamment des sources ; en revanche,
s'il est relatif, il s'appliquera pour chaque répertoire source\~; par
exemple,
.B mksquashfs /tmp/source1 source2 sf_résultant \-e ex1 /tmp/source1/ex2 out/ex3
excluera les fichiers \fI/tmp/source1/ex2\fR, \fI/tmp/source1/ex1\fR,
\fIsource2/ex1\fR, \fI/tmp/source1/out/ex3\fR et
\fIsource2/out/ex3\fR.

Ces options
.B \-e
et
.B \-ef
sont pratiques pour archiver par exemple un système de fichier complet
en évitant le répertoire
.I /proc
et le système de fichiers résultat :
.B mksquashfs / /tmp/root.sqsh \-e proc /tmp/root.sqsh

On peut utiliser plusieurs fois l'option
.B \-ef
dans une même commande, et on peut également l'utiliser en même temps
que l'option \fB\-e\fR.

L'option
.B \-info
affiche les fichiers et répertoires ajoutés au système de fichiers,
avec leur taille originelle et éventuellement le mot DUPLICATE si un
fichier avec un contenu identique y est déjà présent.

Les options
.B \-le
et
.B \-be
peuvent servir à forcer
.B mksquashfs
à générer un système de fichiers little endian ou big endian. Par
défaut,
.B mksquashfs 
génère un système de fichiers avec le boutisme de la machine hôte. Le
pilote Squashfs permettant, par souci de portabilité, de monter les
deux types de systèmes de fichiers (c'est\-à\-dire qu'il peut monter
un système big endian sur une machine little endian), ces options
peuvent servir à améliorer l'efficacité d'un système de fichiers
généré pour une architecture différente.
.SH "OPTIONS"

.TP
.B \-version
affiche la version, la licence et un message de copyright.
.TP
.B \-info
affiche les fichiers ajoutés au système de fichiers
.TP
.B \-b
.I block_size
fixe la taille des blocs de données ; elle peut être de 4096, 8192,
16384, 32768 ou 65536 octets. Par défaut, elle vaut 65536 octets
.TP
.B \-2.0
crée un système de fichiers version 2.0
.TP
.B \-noI
ou
.B \-noInodeCompression
ne comprime pas la table des i\-noeuds
.TP
.B \-noD
ou
.B \-noDataCompression
ne comprime pas les blocs de données
.TP
.B \-noF
ou
.B \-noFragmentCompression
ne comprime pas les blocs fragmentés
.TP
.B \-no\-fragments
n'utilise pas de blocs fragmentés : indique à
.B mksquashfs
de ne pas créer de blocs fragmentés, mais plutôt un système de
fichiers du même genre que la version 1.x de Squashfs. Ce sera quand
même un système de fichiers Squashfs 2.0 (mais sans fragments), donc
il ne pourra être monté par un système Squashfs en version 1.x.

.TP
.B \-always\-use\-fragments
utiliser des blocs fragmentés pour les fichiers plus gros que la
taille d'un bloc : indique à 
.B mksquashfs
d'utiliser des blocs fragmentés quelle que soit la longueur des
fichiers. Par défaut, seuls les petits fichiers (dont la taille est
inférieure à celle d'un bloc) sont assemblés dans des blocs
fragmentés, la fin des fichiers qui ne remplissent un bloc ne sont
.I pas
assemblés dans des fragments. Par exemple, un fichier de 100 ko est
découpé en un bloc de 64 ko et un reste de 36 ko, qui par défaut n'est
pas placé dans un bloc fragmenté. Ce choix est fait pour éviter une
perte de performance de 10 à 20% en accès séquentiel à ce genre de
fichiers, car il faudrait sinon déplacer la tête de lecture d'un
disque pour accéder au(x) bloc(s) entier(s) et un autre pour le
fragment (qui ne sera sans doute pas consécutif). Utilisez cette
option pour forcer ces fins de fichiers à être rassemblées dans les
blocs fragmentés ; cela améliore le taux de compression obtenu
.I mais
au dépens de la vitesse d'accès.
.TP
.B \-no\-duplicates
ne vérifie pas s'il y a des doublons : indique à
.B mksquashfs
de ne pas vérifier dans les fichiers ajoutés s'il y en a avec des
contenus identiques. Ceci permet une génération/modification du
système de fichiers résultant plus rapide, mais bien sûr le taux de
compression sera nettement moins bon s'il y a beaucoup de fichiers aux
contenus identiques.
.TP
.B \-noappend
ne pas ajouter en fin d'un système de fichiers existant
.TP
.B \-keep\-as\-directory
si un seul répertoire source est donné, crée un système de fichiers
contenant ce répertoire plutôt que simplement son contenu.
.TP
.B \-root\-becomes
.I nom
lorsqu'on ajoute des fichiers ou répertoires à un système existant, le
contenu de l'ancien système sera placé dans un répertoire de
.I nom
donné, plutôt que de mélanger les anciens fichiers et les nouveaux.
.TP
.B \-all\-root
ou
.B \-root\-owned
tous les fichiers ajoutés au système appartiendront à root
.TP
.B \-force\-uid
.I uid
tous les fichiers ajoutés au système appartiendront à l'utilisateur
d'identifiant \fIuid\fR (un nom ou un nombre)
.TP
\fB\-force\-gid \fIgid\fR\fR
tous les fichiers ajoutés au système appartiendront au groupe d'identifiant \fIgid\fR (un nom ou un nombre)
.TP
.B \-le
crée un système de fichiers au format petit boutiens (little endian en
anglais)
.TP
.B \-be
crée un système de fichiers au format gros boutiens (big endian en anglais)
.TP
.B \-nopad
Ne pas arrondir le système de fichiers au multiple de 4 ko [supérieur]
: cet arrondi, effectué par défaut, permet au système de fichiers
d'être monté par l'interface loopback qui ne fonctionne qu'avec des
fichiers multiples de 4 ko. Si le système de fichiers est destiné à
être écrit sur un périphérique de type bloc (un disque ou une
partition par exemple) ou être placé dans une image de démarrage, cet
arrondi est inutile.
.TP
.B \-check_data
positionne un drapeau dans le système de fichiers créé pour plus de
vérifications de ce système lorsqu'il est monté
.TP
.B \-sort
.I ordre
trie les fichiers suivant les priorités décrites dans le fichier
\fIordre\fR, qui doit contenir un nom de fichier ou répertoire par
ligne avec sa priorité associée (nombre entre \-32768 à 32767, 0 par
défaut)
.TP
.B \-e
.I liste des rép/fichiers exclus
liste (en ligne) des fichiers et répertoires à exclure
.TP
.B \-ef
.I fichier_exclus
le fichier
.I fichier_exclus
contient la liste des fichiers ou répertoires à exclure, un par ligne
.SH "EXEMPLES"

.PP
Pour les exemples suivants, on utilise deux répertoires : 
.TP 3
\(bu
le répertoire source
.I /home/phillip/test
contient \fIfichier1\fR, \fIfichier2\fR et \fIrep1\fR.
.TP
\(bu
le répertoire source
.I outils
contient \fIoutils1\fR, \fIoutils2\fR et \fIoutils3\fR.
.LP
.SS "Exemple\~1."
.IP
.B mksquashfs /home/phillip/test sf_resultat

va créer un système de fichiers Squashfs contenant dans sa racine les
items \fIfichier1\fR, \fIfichier2\fR et \fIrep1\fR.
.SS "Exemple\~2."
.IP
.B mksquashfs /home/phillip/test outils sf_resultat

va créer un système de fichiers Squashfs contenant dans sa racine les
répertoires \fItest\fR et \fIoutils\fR, correspondant aux répertoires
source \fI/home/phillip/test\fR et \fIoutils\fR.
.SS "Exemple\~3."
.IP
\fBmksquashfs /home/phillip/test outils test sf_resultat\fR

commande identique à l'exemple précédent, sauf qu'un troisième
répertoire source
.I test
a été donné, d'où un conflit avec le premier répertoire \fItest\fR. Ce
troisième répertoire sera donc renommé \fItest_1\fR.

Donner plusieurs répertoires source permet de générer des systèmes de
fichiers sans préalablement copier tous les fichiers nécessaires dans
un répertoire commun, ce qui simplifie le processus.
.SS "Exemple\~4."
.IP
\fBmksquashfs /home/phillip/test sf_resultat \-keep\-as\-directory\fR

commande identique au premier exemple, sauf que l'option
.B \-keep\-as\-directory
va donner un système de fichiers dont la racine contiendra un
répertoire \fItest\fR et son contenu \fIfichier1\fR, \fIfichier2\fR et
\fIrep1\fR, au lieu de n'avoir que son contenu.
.SH "AUTEURS"

.PP
Squashfs a été écrit par Phillip Lougher
<plougher@users.sourceforge.net>, à Chepstow, Pays de Galles,
Royaume\-Uni. Si vous appréciez ce programme ou rencontrez des
problèmes en l'utilisant, contactez\-le, il est intéressé par des
retours d'expérience.

.PP
Cette page de manuel a été écrit par Frédéric Boiteux
<fboiteux@calistel.com> pour le système Debian (mais peut être utilisé
par d'autres) à partir du document SquashFS HOWTO de Artemiy I. Pavlov
et du fichier \fIREADME\fR des sources de SquashFS. Il est permis de
copier, distribuer et/ou modifier ce document en vertu de la licence
GPL version 2 ou postérieure, telle que publiée par la Free Software
Foundation.

.PP
Sur les systèmes Debian, le texte complet de la licence GNU GPL (GNU
General Public License) est accessible dans le fichier
\fI/usr/share/common\-licenses/GPL\fR.

.PP
Traduction française : Frédéric Boiteux <fboiteux@calistel.com>.

Attachment: pgpmNUlzsmvXm.pgp
Description: PGP signature


Reply to: