Attributs de fichier de contrôle

Télécharger (PDF)

Mise à jour2025-10-21
Temps de lecture : 9 minute(s)

Un fichier de contrôle est un fichier texte sans extension qui contient des métadonnées décrivant les propriétés et les relations du paquet, telles que son nom, sa version, son type et ses dépendances. Les paquets de fichiers et les paquets WinInst requièrent un fichier de contrôle. Le Gestionnaire de paquets génère le paquet selon les métadonnées contenues dans le fichier de contrôle.


Nom de l'attribut	Requis	Type	Par défaut	Description	Exemple
Architecture	Oui	Chaîne	N/A	Indique l'architecture du système d'exploitation prise en charge par le paquet. Valeurs attendues : windows_x64 (Installable uniquement sur Windows 64 bits) windows_all (Obsolète avec la suppression de Windows 32 bits)	Architecture: windows_all Remarque Vous ne pouvez spécifier qu'une architecture par paquet.
Conflicts	Non	Tableau de relation de chaînes	NULL	Déclare un conflit entre un paquet binaire et un autre. Le Gestionnaire de paquets n'installera pas les paquets en conflit sur un système en même temps. Pour les paquets pour lesquels XB-Plugin est défini à eula, vous pouvez empêcher l'installation du paquet de CLUF sur le disque en définissant cette valeur à ni-package-manager.	Référez-vous à la section Tableau de relation de chaînes pour obtenir un exemple.
Depends	Non	Tableau de relation de chaînes	NULL	Déclare une dépendance absolue. Les paquets windows_x64 ne doivent dépendre que des paquets windows_x64 et windows_all. Les paquets windows_all ne doivent dépendre que des paquets windows_all. Le paquet spécial system-windows-x64 peut être utilisé comme élément de substitution pour les dépendances 64 bits.	Référez-vous à la section Tableau de relation de chaînes pour obtenir un exemple.
Description	Oui	Attributs multilignes	N/A	Fournit une description du paquet binaire. Se compose de deux parties : le synopsis sur une seule ligne et la description longue sur plusieurs lignes. NI recommande d'utiliser deux caractères d'espace blanc entre le synopsis et la description longue pour en améliorer la lisibilité. Vous pouvez éventuellement spécifier du texte localisé. Voir Attributs localisés.	Référez-vous à la section Attributs multilignes pour obtenir un exemple.
Enhances	Non	Tableau de relation de chaînes	NULL	Déclare qu'un paquet améliore la fonctionnalité d'un autre paquet. Utilisez cet attribut uniquement dans les paquets pour lesquels XB-UserVisible est défini à yes.	Référez-vous à la section Tableau de relation de chaînes pour obtenir un exemple.
Homepage	Non	Chaîne	NULL	L'URL que le fournisseur de paquet utilise pour fournir des informations plus détaillées sur le paquet.	Homepage: http://www.ni.com
Installed-Size	Non	Entier long	0	Fournit une estimation de l'espace disque total requis pour installer le paquet. Valeur attendue : une valeur entière de la taille d'installation estimée en octets, divisée par 1024 et arrondie.	Installed-Size: 25485141
Maintainer	Oui	Chaîne	N/A	Le nom et l'adresse e-mail du mainteneur du paquets. Valeurs attendues : le nom du mainteneur suivi de l'adresse électronique à l'intérieur des chevrons.	Maintainer: National Instruments <support@ni.com>
Package	Oui	Chaîne	N/A	Spécifie une identification unique pour un paquet. Un nom de paquet doit être une chaîne unique et simple qu'un client peut saisir sur la ligne de commande, et doit remplir les conditions suivantes : Ne comporter que des lettres minuscules (a-z), des chiffres (0-9), des signes plus (+) et moins (-) et des points (.) Commencer par un caractère alphanumérique Ne doit pas contenir de lettres majuscules Avoir une longueur minimale de deux caractères Avoir une longueur maximale de 58 caractères Valeurs attendues : Correspondre à l'expression régulière ^[a-z0-9][a-z0-9.+-]{2,}$ NI vous recommande de commencer le nom de votre paquet avec le nom de votre société suivi d'un tiret (ex : ni-testpackage)	Bonne syntaxe : Package: ni-labview-2015 Package: ni-daqmx Package: ni-daqmx-labview-2015-support Syntaxe incorrecte : Package: LabVIEW_2015 Package: NationalInstrumentsGPIB Package: labview
Provides	Non	Tableau de relation de chaînes	NULL	Déclare que le paquet satisfait une dépendance absolue d'un autre paquet.	Référez-vous à la section Tableau de relation de chaînes pour obtenir un exemple.
Recommends	Non	Tableau de relation de chaînes	NULL	Déclare une forte dépendance qui n'est pas absolue. Liste les paquets qui seraient installés avec celui-ci dans la plupart des situations. Recommande uniquement des paquets pour lesquels XB-UserVisible est défini à yes.	Référez-vous à la section Tableau de relation de chaînes pour obtenir un exemple.
Replaces	Non	Tableau de relation de chaînes	NULL	Déclare que le paquet remplace d'autres paquets. Conflicts doit être utilisé conjointement à Replaces.	Référez-vous à la section Tableau de relation de chaînes pour obtenir un exemple.
Section	Non	Chaîne	NULL	Spécifie la catégorie dans laquelle le paquet est classé. Valeurs attendues : Programming Environments Application Software Add-Ons Drivers Runtime Utilities Documentation Infrastructure Pour les paquets pour lesquels XB-Plugin est défini à eula, vous devez définir cette valeur à Infrastructure. Consultez Assembler un paquet de CLUF pour en savoir plus sur la création de paquets de CLUF.	Section: Application Software
Suggests	Non	Tableau de relation de chaînes	NULL	Déclare qu'un paquet peut être plus utile avec un ou plusieurs autres paquets. Notifie le Gestionnaire de paquets et l'utilisateur que les paquets répertoriés sont liés à celui-ci, mais pas requis. Suggère uniquement des paquets pour lesquels XB-UserVisible est défini à yes.	Référez-vous à la section Tableau de relation de chaînes pour obtenir un exemple.
Supplements	Non	Tableau de relation de chaînes	NULL	Déclare qu'un paquet complète la fonctionnalité d'un autre paquet. Utilisez cet attribut uniquement dans les paquets pour lesquels XB-UserVisible est défini à yes.	Référez-vous à la section Tableau de relation de chaînes pour obtenir un exemple.
Version	Oui	Chaîne	N/A	Spécifie le numéro de version du paquet. Utilisez le format Debian. Pour en savoir plus, consultez https://www.debian.org.	Version: 17.1.0.1
XB-DisplayName	Non	Chaîne	NULL	Nom de paquet convivial. Vous pouvez éventuellement spécifier du texte localisé. Voir Attributs localisés.	XB-DisplayName: NI LabVIEW 2017
XB-DisplayVersion	Non	Chaîne	NULL	Version d'affichage conviviale.	XB-DisplayVersion: 15.0.0
XB-Eula	Non	Tableau de relation de chaînes	NULL	Déclare les paquets de CLUF requis par le paquet.	XB-Eula: eula-mycompany, eula-ni-standard
XB-EulaTitle	Non	Chaîne	NULL	Spécifie le titre affiché du paquet de CLUF. N'utilisez cet attribut que dans les paquets pour lesquels XB-Plugin est défini à eula.	XB-EulaTitle: My Software Name
XB-MessageCondition-# Par exemple : XB-MessageCondition-1, XB-MessageCondition-2, etc.	Non	Chaîne	N/A	Spécifie une condition pour laquelle le message correspondant s'affichera dans le Gestionnaire de paquets. Seules les conditions MSI sont acceptées et doivent être incluses entre les balises <msi>...</msi>. À moins que le texte entre les balises ne se trouve dans un bloc CDATA, les caractères "<" et ">" doivent être échappés en "&lt" et "&gt".	XB-MessageCondition-1: <msi>VISA32COMPANYNAME ~<> "National Instruments"</msi> XB-MessageCondition-2: <msi><![CDATA[VISA32COMPANYNAME ~<> "National Instruments"]]></msi>
XB-MessageText-# Par exemple : XB-MessageText-1, XB-MessageText-2, etc.	Non	Attributs multilignes	N/A	Contient un message important affiché par le Gestionnaire de paquets avant d'installer le paquet. Se compose de deux parties, un en-tête et un texte. Vous pouvez spécifier une condition pour l'affichage de ce message en utilisant l'attribut MessageCondition correspondant ci-dessous. Si vous ne spécifiez pas de condition, ce message sera toujours affiché lors de l'installation de ce paquet. NI vous recommande de créer du texte préformaté pour chaque ligne de texte en utilisant deux espaces au début de chaque ligne. Vous pouvez éventuellement spécifier du texte localisé. Voir Attributs localisés.	XB-MessageText-1: This is my message header This is my message body. There are multiple lines.
XB-OsRequires	Non	Chaîne	N/A	Déclare les versions de système d'exploitation requises par le paquet. Si vous ne spécifiez pas XB-OsRequires, tous les systèmes d‘exploitation que le Gestionnaire de paquets prend en charge actuellement sont autorisés. Définissez la restriction de bitness du système d‘exploitation à l‘aide de l‘attribut Architecture. Si le système d‘exploitation d‘un système ne peut pas satisfaire à XB-OsRequires pour un paquet, l'interface graphique du Gestionnaire de paquets ne peut pas afficher le paquet. Si un paquet a une dépendance pour laquelle XB-OsRequires est plus restrictif, le paquet hérite des exigences de système d‘exploitation les plus restrictives.	Référez-vous à la section Système d‘exploitation requis pour obtenir un exemple.
XB-Plugin	Oui	Chaîne	NULL	L'Agent utilisé pour installer le paquet. Valeurs attendues : eula file wininst relative-file	XB-Plugin: file
XB-ReleaseNotes	Non	Attributs multilignes	NULL	Notes d'information pour le paquet. Vous pouvez éventuellement spécifier du texte localisé. Voir Attributs localisés.	Référez-vous à la section Attributs multilignes pour obtenir un exemple.
XB-StoreProduct	Non	Booléen	no	Indique si le paquet est un produit du Gestionnaire de paquets. Vous devez définir la valeur à yes pour que votre paquet apparaisse sous les onglets Installés et Paquets lorsque la case Produits uniquement est cochée. Valeurs attendues : no yes	XB-StoreProduct: no
XB-UserVisible	Non	Booléen	no	Spécifie si le Gestionnaire de paquets affiche le paquet. Valeurs attendues : no yes Vous devez définir la valeur à no pour les paquets pour lesquels XB-Plugin est défini à eula. Consultez Assembler un paquet de CLUF pour en savoir plus sur la création de paquets de CLUF.	XB-UserVisible: no
XB-VisibleForRuntimeDeployment	Non	Booléen	no	Spécifie si NI Package Builder affiche le paquet par défaut lorsque des dépendances sont ajoutées. Valeurs attendues : no yes	XB-VisibleForRuntime: yes

Tableau de relation de chaînes

Le Gestionnaire de paquets s'attend à un tableau de relation de chaînes ou à une liste de noms de paquets séparés par des virgules comme valeur des attributs de fichier de contrôle qui déclarent les relations.

Formatez ces valeurs d'attribut selon les règles de syntaxe suivantes :

Séparez les noms de paquets par des virgules.
Séparez les noms de paquets alternatifs pour toute dépendance en utilisant des barres verticales. Cela indique que l'un des paquets alternatifs répertoriés répond à la dépendance.
Ajoutez les exigences de version d'un paquet entre parenthèses après le nom du paquet. Vous pouvez restreindre l'applicabilité de chaque paquet à des versions particulières dans tous les champs de tableaux de relation de chaînes à l'exception de Provides.
Dans les parenthèses, utilisez l'un des opérateurs suivants suivi d'un numéro de version pour indiquer la relation entre le paquet et la version. Vous pouvez utiliser l'espace blanc dans la spécification de la version.


Opérateur	Relation
<<	strictement antérieur
<=	antérieur ou égal
=	exactement égal
>=	ultérieur ou égal
>>	strictement ultérieur
!=	exclusion

Dans l'exemple suivant, l'attribut Depends déclare une dépendance sur la version 2.2.1 ou ultérieure de package01 et indique que package03 est un paquet alternatif qui satisfait à la dépendance sur package02.

Depends: package01 (>= 2.2.1), package02 | package03

Attributs multilignes

La valeur d'un attribut multilignes consiste en un synopsis à une seule ligne suivi de lignes supplémentaires qui fournissent une description étendue.

La première ligne d'un attribut multilignes est réservée pour le nom de l'attribut suivi d'un synopsis à une seule ligne. Fournissez une courte description ou un titre pour cette partie de l'attribut. Les attributs XB-ReleaseNotes n'utilisent pas de synopsis à une seule ligne.

La description étendue contient les détails supplémentaires que vous fournissez pour l'attribut. Formatez la description étendue d'un attribut multilignes selon les règles suivantes :

créer un paragraphe en utilisant un seul espace au début d'une ligne. Lors de l'affichage de ce texte, le programme d'affichage supprime l'espace avant et utilise le retour à la ligne. Un paragraphe doit contenir au moins un caractère espace blanc.
préserver les espaces blancs et les sauts de ligne à l'aide de deux espaces ou plus au début d'une ligne. Si la zone d'affichage ne défile pas horizontalement et qu'une ligne est trop longue pour s'adapter, le programme d'affichage crée des sauts de ligne si nécessaire.
créer une ligne vide en utilisant un seul espace suivi d'un point.

Le texte suivant fournit un exemple de la façon dont vous pouvez utiliser les règles de formatage pour les attributs multilignes pour saisir du texte pour l'élément Description :

      Description : Exemple de contenu d'attribut multiligne.
  L'espace unique au début de cette ligne crée un paragraphe. 
 .
    L'espace double au début de ces lignes crée un texte préformaté qui préserve les espaces et les sauts de ligne.

Système d'exploitation requis

La version XB-OsRequires comprend jusqu'à trois champs d‘entiers pour les versions du système d'exploitation Windows. Les deux premiers champs correspondent aux versions du système d'exploitation Windows telles que spécifiées par Microsoft à la page Operating System Version. Le troisième champ s'applique uniquement aux OS builds de Windows 10 telles que spécifiées par Microsoft à la page Informations sur les versions Windows 10.

Formatez les champs d'attribut selon les règles de syntaxe suivantes :

Séparer les champs à l'aide de points.
Séparer les exigences multiples par des virgules.
Spécifier des exigences alternatives à l'aide de barres verticales. Les barres verticales prévalent sur les virgules.
Les opérateurs suivants sont supportés par cet attribut.
Opérateur Relation
<< inférieur à
<= inférieur ou égal à
= égal à
>= supérieur ou égal à
>> supérieur à
!= exclusion

Opérateur	Relation
<<	inférieur à
<=	inférieur ou égal à
=	égal à
>=	supérieur ou égal à
>>	supérieur à
!=	exclusion

Le tableau suivant affiche des exemples sur la manière d‘utiliser XB-OsRequires :


Exemple	Condition résultante
XB-OsRequires: >=6.3	Windows 8.1 ou plus récent
XB-OsRequires: >=10.0, !=10.0.18363	Windows 10 ou plus récent, mais pas Windows 10 version 1909
XB-OsRequires: >=6.3, <10 \| >=10.0.18363	Windows 8.1 ou plus récent et, soit le système d'exploitation est plus ancien que Windows 10, soit c'est Windows 10 version 1909 ou une version plus récente.

Attributs localisés

La description, le nom d'affichage, les notes d'information et le texte du message apparaissent localisés dans l'interface utilisateur du Gestionnaire de paquets lorsque vous incluez des versions des attributs auxquelles sont ajoutées un suffixe spécifique à la langue.

L'interface graphique du Gestionnaire de paquets affiche le texte localisé pour les attributs Description, XB-DisplayName, XB-Releasenotes et XB-MessageText lorsque vous incluez des versions localisées de ces attributs. Pour les versions localisées de ces attributs, le nom de l'attribut est suivi d'un trait d'union et d'un suffixe spécifique à la langue. Si aucun attribut spécifique à la langue ne correspond à la langue de l'interface graphique du Gestionnaire de paquets, le texte de l'attribut non localisé est utilisé.

Par exemple, un fichier de contrôle LabVIEW peut inclure les attributs XB-DisplayName suivants :

DisplayName: LabVIEW (64-bit) English
DisplayName-de: LabVIEW (64 Bit) – Englisch
DisplayName-es: LabVIEW (64 bits) – Español
DisplayName-fr: LabVIEW (64 bits) – Anglais
DisplayName-it: LabVIEW (64 bit) – Italiano
DisplayName-ja: LabVIEW (64ビット) 英語版
DisplayName-ko: LabVIEW (64비트) 영어 버전
DisplayName-zh-CN: LabVIEW（64位）英语版

Contenu associé

Assembler un paquet de CLUF
Assemblez un paquet de CLUF (contrat de licence utilisateur final) en créant un répertoire racine qui contient des sous-répertoires, des fichiers source et des fichiers de configuration.
Assembler un paquet de fichiers relatifs
Assemblez un paquet de fichiers relatifs en créant un répertoire racine qui contient des sous-répertoires, des fichiers source et des fichiers de configuration.
Assembler un paquet de fichiers
Assemblez un paquet de fichiers en créant un répertoire racine qui contient des sous-répertoires, des fichiers source et des fichiers de configuration.
Assembler un paquet WinInst
Assemblez un paquet Windows Installer (WinInst) en créant un répertoire racine qui contient des sous-répertoires, des fichiers source et des fichiers de configuration.