Eine Steuerdatei ist eine erweiterungslose Textdatei mit Metadaten, mit denen die Eigenschaften des Pakets (z. B. Name, Version, Typ) und die Beziehungen unter den Bestandteilen des Pakets (z. B. Abhängigkeiten) beschrieben werden. Für Dateipakete und WinInst-Pakete ist eine Steuerdatei erforderlich. Der Paketmanager erzeugt das Paket entsprechend den Metadaten in der Steuerdatei.

Attributname Erforderlich Typ Standard Beschreibung Beispiel
Architecture Ja String k. A. Gibt die vom Paket unterstützte Betriebssystemarchitektur an.
Erwartete Angaben:
  • windows_x64 (kann nur auf Windows 64 Bit installiert werden)
  • windows_all(Veraltet, entlang mit 32-Bit-Windows)
 Architecture: windows_all
Hinweis Sie können nur eine Architektur pro Paket angeben.
Conflicts Nein String-Beziehungstabelle NULL Zeigt einen Konflikt zwischen einem Binärpaket und einem anderen an.

In Konflikt stehende Pakete werden vom Paketmanager nicht zusammen auf einem System installiert.

Für Pakete mit einem auf eula eingestellten XB-Plugin können Sie verhindern, dass das EULA-Paket auf der Festplatte installiert wird, indem Sie diesen Wert auf ni-package-manager festlegen.

 Ein Beispiel finden Sie im Abschnitt String-Beziehungstabelle.
Depends Nein String-Beziehungstabelle NULL Zeigt eine absolute Abhängigkeit an.
  • windows_x64-Pakete sollten nur abhängig sein von windows_x64- und windows_all-Paketen.
  • windows_all-Pakete sollten nur von windows_all-Paketen abhängig sein.
  • Sonderpaket system-windows-x64 kann als Platzhalter für 64-Bit-Abhängigkeiten verwendet werden.
 Ein Beispiel finden Sie im Abschnitt String-Beziehungstabelle.
Description Ja Mehrzeilig k. A. Gibt eine Beschreibung des Binärpakets an.

Besteht aus einer einzeiligen Kurzbeschreibung und einer mehrzeiligen ausführlichen Beschreibung.

Es wird empfohlen, zwischen der Kurzbeschreibung und der ausführlichen Beschreibung aus Gründen der besseren Lesbarkeit zwei Leerräume zu setzen.

Sie können optional lokalisierten Text angeben. Mehr dazu finden Sie unter Lokalisierte Attribute.

 Ein Beispiel finden Sie im Abschnitt Mehrzeilige Attribute.
Enhances Nein String-Beziehungstabelle NULL Zeigt an, dass ein Paket den Funktionsumfang eines anderen Pakets verbessert.

Verwenden Sie dieses Attribut nur in Paketen, bei denen XB-UserVisible auf yes eingestellt ist.

 Ein Beispiel finden Sie im Abschnitt String-Beziehungstabelle.
Homepage Nein String NULL URL, über die der Anbieter des Pakets detailliertere Angaben zu einem Paket bereitstellt. Homepage: http://www.ni.com
Installed-Size Nein Long-Integer 0 Gibt den geschätzten Speicherplatzbedarf für die Installation des Pakets an.

Erwarteter Wert: Geschätzter Speicherplatz in Byte (Ganzzahl), durch 1024 dividiert und aufgerundet.

 Installed-Size: 25485141
Maintainer Ja String k. A. Der Name und die E-Mail-Adresse des Herausgebers des Pakets.

Erwartete Angabe: der Name des Herausgebers gefolgt von der E-Mail-Adresse in spitzen Klammern.

 Maintainer: National Instruments <support@ni.com>
Package Ja String k. A. Gibt eine eindeutige Kennung für ein Paket an.
Ein Paketname muss ein eindeutiger, benutzerfreundlicher String sein, der sich zur Eingabe in die Kommandozeile eignet. Dabei gelten folgende Beschränkungen:
  • Darf nur Kleinbuchstaben, Ziffern (0-9), Plus-/Minuszeichen und Punkte enthalten
  • Muss mit einem alphanumerischen Zeichen beginnen
  • Darf keine Großbuchstaben enthalten
  • Muss mindestens 2 Zeichen enthalten
  • Darf maximal 58 Zeichen enthalten
Erwartete Angaben:
  • Muss mit dem regulären Ausdruck ^[a-z0-9][a-z0-9.+-]{2,}$ erkennbar sein
  • NI empfiehlt, dass Sie den Namen Ihres Pakets mit Ihrem Firmennamen beginnen und danach einen Bindestrich setzen (wie in ni-testpaket)

Zulässige Syntax:

  • Package: ni-labview-2015
  • Package: ni-daqmx
  • Package: ni-daqmx-labview-2015-support

Inkorrekte Syntax:

  • Package: LabVIEW_2015
  • Package: NationalInstrumentsGPIB
  • Package: labview
Provides Nein String-Beziehungstabelle NULL Zeigt an, dass das Paket eine absolute Abhängigkeit eines anderen Pakets erfüllt. Ein Beispiel finden Sie im Abschnitt String-Beziehungstabelle.
Recommends Nein String-Beziehungstabelle NULL Zeigt eine starke Abhängigkeit an, die jedoch nicht absolut ist.

Listet Pakete auf, die üblicherweise zusammen mit dem vorliegenden Paket installiert werden.

Nur empfohlene Pakete, bei denen XB-UserVisible auf yes eingestellt ist.

 Ein Beispiel finden Sie im Abschnitt String-Beziehungstabelle.
Replaces Nein String-Beziehungstabelle NULL Zeigt an, dass das Paket andere Pakete ersetzt.

Conflicts sollte in Verbindung mit Replaces genutzt werden.

 Ein Beispiel finden Sie im Abschnitt String-Beziehungstabelle.
Section Nein String NULL Gibt die Kategorie an, der das Paket zugeordnet wird.
Erwartete Angaben:
  • Programming Environments
  • Application Software
  • Add-Ons
  • Drivers
  • Runtime
  • Utilities
  • Documentation
  • Infrastructure

Für Pakete, deren XB-Plugin auf eula gesetzt ist, muss dieser Wert auf Infrastructure eingestellt sein. Weitere Informationen zum Erstellen von EULA-Paketen finden Sie unter "Zusammenstellen eines Lizenzvertragspakets".

 Section: Application Software
Suggests Nein String-Beziehungstabelle NULL Zeigt an, dass sich ein größerer Nutzwert erzielen lässt, wenn das betreffende Paket mit anderen Paketen installiert wird.

Informiert den Paketmanager und den Benutzer, dass die aufgelisteten Pakete mit dem betreffenden Paket in Beziehung stehen, jedoch verzichtbar sind.

Nur vorgeschlagene Pakete, bei denen XB-UserVisible auf yes eingestellt ist.

 Ein Beispiel finden Sie im Abschnitt String-Beziehungstabelle.
Supplements Nein String-Beziehungstabelle NULL Zeigt an, dass ein Paket den Funktionsumfang eines anderen Pakets ergänzt.

Verwenden Sie dieses Attribut nur in Paketen, bei denen XB-UserVisible auf yes eingestellt ist.

 Ein Beispiel finden Sie im Abschnitt String-Beziehungstabelle.
Version Ja String k. A. Gibt die Version des Pakets an.

Die Angabe wird im Debian-Format erwartet. Weitere Informationen finden Sie auf der Website https://www.debian.org.

 Version: 17.1.0.1
XB-DisplayName Nein String NULL Benutzerfreundlicher Paketname.

Sie können optional lokalisierten Text angeben. Mehr dazu finden Sie unter "Lokalisierte Attribute".

 XB-DisplayName: NI LabVIEW 2017
XB-DisplayVersion Nein String NULL Benutzerfreundliche Anzeigeversion. XB-DisplayVersion: 15.0.0
XB-Eula Nein String-Beziehungstabelle NULL Gibt an, welche EULA-Pakete das Paket erfordert. XB-Eula: eula-mycompany, eula-ni-standard
XB-EulaTitle Nein String NULL Gibt den angezeigten Titel des EULA-Pakets an. Verwenden Sie dieses Attribut nur in Paketen, für die das XB-Plugin auf eula eingestellt ist. XB-EulaTitle: My Software Name
XB-MessageCondition-#

Beispiel:

XB-MessageCondition-1, XB-MessageCondition-2, etc.

 Nein String k. A. Gibt eine Bedingung dafür an, wann die entsprechende Nachricht im Paketmanager angezeigt werden soll.

Es werden nur MSI-Bedingungen akzeptiert und diese sollten in <msi>...</msi>-Tags eingeschlossen sein. Wenn Text in Tags nicht in einem CDATA-Block eingeschlossen ist, müssen die Zeichen '<' und '>' als '&lt' und '&gt' eingegeben werden.

 
XB-MessageCondition-1: <msi>VISA32COMPANYNAME ~&lt;&gt; "National Instruments"</msi>
XB-MessageCondition-2: <msi><![CDATA[VISA32COMPANYNAME ~<> "National Instruments"]]></msi>
XB-MessageText-# Zum Beispiel:

XB-MessageText-1, XB-MessageText-2, etc.

 Nein Mehrzeilig k. A. Enthält eine wichtige Meldung, die der Paketmanager vor der Installation des Pakets anzeigt.

Besteht aus zwei Teilen: einer Kopfzeile und einem Textkörper.

Sie können mit Hilfe des entsprechenden MessageCondition-Attributs eine Bedingung für die Anzeige dieser Nachricht angeben. Wenn Sie keine Bedingung angeben, wird diese Nachricht immer angezeigt, wenn Sie dieses Paket installieren.

Es wird empfohlen, vorformatierten Text für jede Zeile des Textkörpers zu verwenden, in dem jede Zeile mit zwei Leerzeichen beginnt.

Sie können optional lokalisierten Text angeben. Mehr dazu finden Sie unter "Lokalisierte Attribute".

 XB-MessageText-1: This is my message header

This is my message body.

There are multiple lines.

XB-OsRequires Nein String k. A. Gibt an, welche Version des Betriebssystems das Paket erfordert.

Wenn XB-OsRequires nicht spezifiziert wird, sind alle Betriebssysteme zulässig, welche gegenwärtig vom Paketmanager unterstützt werden.

Definieren Sie die zulässige Bit-Version des Betriebssystems mit Hilfe des Attributs Architecture.

Wenn das Betriebssystem eines Systems dem Attribut XB-OsRequires nicht genügt, wird das Paket nicht in der GUI des Paketmanagers angezeigt.

Wenn ein Paket eine Abhängigkeit von einem restriktiveren Attribut XB-OsRequires, erbt das Paket die restriktivere Anforderung für das Betriebssystem.

 Ein Beispiel finden Sie im Abschnitt Betriebssystemanforderungen.
XB-Plugin Ja String NULL Der zum Installieren des Pakets verwendete Agent.
Erwartete Angaben:
  • eula
  • file
  • wininst
  • relative-file
 XB-Plugin: file
XB-ReleaseNotes Nein Mehrzeilig NULL Versionshinweise für das Paket.

Sie können optional lokalisierten Text angeben. Mehr dazu finden Sie unter Lokalisierte Attribute.

 Ein Beispiel finden Sie im Abschnitt Mehrzeilige Attribute.
XB-StoreProduct Nein Boolesch no Gibt an, ob das Paket ein Produkt im Paketmanager ist.

Sie müssen den Wert auf yes einstellen, damit Ihr Paket auf den Registerkarten Installiert und Pakete angezeigt wird, wenn Nur Produkte aktiviert ist.

Erwartete Angaben:
  • no
  • yes
 XB-StoreProduct: no
XB-UserVisible Nein Boolesch no Gibt an, ob der Paketmanager das Paket anzeigt.
Erwartete Angaben:
  • no
  • yes

Sie müssen den Wert auf no festlegen für Pakete, für die das XB-Plugin auf eula eingestellt ist. Weitere Informationen zum Erstellen von EULA-Paketen finden Sie unter "Zusammenstellen eines Lizenzvertragspakets".

 XB-UserVisible: no
XB-VisibleForRuntimeDeployment Nein Boolesch no Gibt an, ob NI Package Builder das Paket standardmäßig anzeigt, wenn abhängige Komponenten hinzugefügt werden.
Erwartete Angaben:
  • no
  • yes
 XB-VisibleForRuntime: yes

String-Beziehungstabelle

Der Paketmanager erwartet als Steuerdateiattribute eine String-Beziehungstabelle bzw. eine kommagegliederte Liste mit Paketnamen.

Formatieren Sie diese Attributwerte wie folgt:

  • Paketnamen sind durch Kommas voneinander zu trennen.
  • Alternative Paketnamen für abhängige Komponenten sind durch vertikale Striche voneinander zu trennen. Dadurch wird angezeigt, dass jedes der aufgelisteten alternativen Pakete für die abhängige Komponente zulässig ist.
  • Fügen Sie, wenn eine bestimmte Version eines Pakets erforderlich ist, die Version in Klammern nach dem Paketnamen hinzu. In allen String-Array-Feldern mit Ausnahme von Provides kann die Anwendbarkeit jedes Pakets auf bestimmte Versionen beschränkt werden.
  • Verwenden Sie in der Klammer einen der folgenden Operatoren gefolgt von einer Versionsnummer, um die Beziehung zwischen dem Paket und der Version anzugeben. Die Versionsangabe kann Leerräume enthalten.
Operator Beziehung
<< strikt älter
<= älter oder identisch
= genau identisch
>= neuer oder identisch
>> strikt neuer
!= ausschließlich

Im folgenden Beispiel deklariert das Attribut Depends eine Abhängigkeit von Paket01 Version 2.2.1 oder neuer und gibt an, dass die Verwendung von Paket03 anstelle von Paket02 akzeptabel ist.

Depends: Paket01 (>= 2.2.1), Paket02 | Paket03

Mehrzeilige Attribute

Der Wert eines mehrzeiligen Attributs besteht aus einer einzeiligen Kurzbeschreibung gefolgt von zusätzlichen Zeilen mit einer ausführlicheren Beschreibung.

Die erste Zeile eines mehrzeiligen Attributs ist für den Attributnamen und eine einzeilige Kurzbeschreibung reserviert. Geben Sie eine kurze Beschreibung oder Überschrift für diesen Teil des Attributs an. Bei Attributen des Typs XB-ReleaseNotes fehlt die einzeilige Kurzbeschreibung.

Die ausführliche Beschreibung enthält zusätzliche Einzelheiten, die Sie zum Attribut angeben. Formatieren Sie die ausführliche Beschreibung eines mehrzeiligen Attributs wie folgt:

  • Erstellen Sie einen Absatz mit einem Leerzeichen am Anfang einer Zeile. Beim Darstellen dieses Texts entfernt das Anzeigeprogramm das führende Leerzeichen und fügt Zeilenumbrüche ein. Ein Absatz muss zumindest einige Zeichen enthalten, bei denen es sich nicht um Leerräume handelt.
  • Zum Beibehalten von Leerräumen und Zeilenumbrüchen im Text sind an den Zeilenanfang zwei oder mehr Leerzeichen zu stellen. Wenn der Anzeigebereich keinen horizontalen Bildlauf durchführt und eine Zeile zu lang ist, kann das Anzeigeprogramm bei Bedarf Zeilenumbrüche erzeugen.
  • Erstellen Sie eine leere Zeile mit einem einzelnen Leerzeichen gefolgt von einem Punkt.

Nachfolgend wird die richtige Formatierung für ein mehrzeiliges Attribut zur Texteingabe für das Element Description gezeigt: 

      Description: Beispiel für mehrzeilige Attribute.
 Mit dem einzelnen Leerzeichen am Anfang dieser Zeile wird ein Absatz erzeugt. 
 .
  Mit dem doppelten Leerzeichen am Anfang dieser Zeilen wird
  vorformatierter Text erstellt, in dem Leerräume und Zeilenumbrüche beibehalten werden.

Betriebssystemanforderungen

Die XB-OsRequires-Version enthält maximal drei Felder mit Ganzzahlen für die Version des Windows-Betriebssystems. Die ersten beiden Felder entsprechen den von Microsoft unter Operating System Version angegebenen Versionsnummern für Betriebssysteme von Windows. Das dritte Feld gilt nur für die von Microsoft unter Windows10-Versionsinformationen angegebenen Builds für Windows-10-Betriebssysteme.

Formatieren Sie die Attributfelder gemäß den folgenden Syntaxregeln:

  • Trennen Sie Felder durch Punkte voneinander.
  • Trennen Sie mehrere Anforderungen durch Kommas voneinander.
  • Geben Sie alternative Anforderungen mit Hilfe vertikaler Balken an. Vertikale Balken haben Vorrang vor Kommas.
  • Die folgenden Operatoren werden von diesem Attribut unterstützt:
    Operator Beziehung
    <<kleiner als
    <=kleiner als oder gleich
    =gleich
    >=größer als oder gleich
    >>größer als
    !=ausschließlich
In der folgenden Tabelle finden Sie Beispiele für die Verwendung von XB-OsRequires:
BeispielGeltende Anforderung
XB-OsRequires: >=6.3
Erfordert Windows 8.1 oder neuer
XB-OsRequires: >=10.0, !=10.0.18363
Erfordert Windows 10 oder neuer, jedoch nicht Windows 10 Version 1909
XB-OsRequires: >=6.3, <10 | >=10.0.18363
Erfordert Windows 8.1 oder neuer und entweder ist das Betriebssystem älter als Windows 10 oder es ist Windows 10 Version 1909 oder neuer

Lokalisierte Attribute

Beschreibungen, Anzeigename, Versionshinweise und Message-Text werden in der Benutzeroberfläche des Paketmanagers lokalisiert angezeigt, wenn Sie Versionen der Attribute einschließen, denen ein sprachspezifisches Suffix angehängt ist.

Die Paketmanager-GUI zeigt lokalisierten Text für die Attribute "Description", "XB-DisplayName", "XB-ReleaseNotes", and "XB-MessageText" an, wenn Sie lokalisierte Versionen dieser Attribute einschließen. Lokalisierte Versionen dieser Attribute werden mit einem Bindestrich und einem sprachspezifischen Suffix an den Attributnamen angehängt. Wenn kein sprachspezifisches Attribut vorliegt, das mit der Sprache der Paketmanager-GUI übereinstimmt, wird der nicht lokalisierte Attributtext verwendet.

Beispielsweise könnte eine LabVIEW-Steuerdatei die folgenden XB-DisplayName-Attribute enthalten:
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位）英语版