Subversion Repositories SvarDOS

AMB1index.ama⸃pkg.ama¤D0.network.amaè¶ltitle

…—contact.ama
±°pkgfmt.amag»^pkgrules.amaxÊXlicense.ama’Gmeaning.amaÙ‡mUtodo.ama`"ð­freedos.amaP(#

AMB1index.amaöïwpkg.amaåD0.network.ama)¶lcontact.amaB
±°pkgfmt.amaEg»^pkgrules.ama¬ÊXlicense.amaÆGmeaning.ama
‡mUtodo.ama”"ñ²`freedos.ama…(M

Ş

[Âhistory.amaÒ2ë±titleÕ9!ÿ

                            %h*** SVARDOS HELP ***

                            %h*** SVARDOS HELP ***

This help documentation is a work-in-progress thing. For the time being it

This help documentation is a work-in-progress thing. For the time being it

provides only very limited informations. (wanna help building it? get in touch

provides only very limited content. (wanna help building it? get in touch with

with us on the SvarDOS mailing list!)

us on the SvarDOS %lcontact.ama:mailing list%t!)

=== Chapters =================================================================

=== Chapters =================================================================

 * %lpkg.ama:Packages management (install/remove/update software)

 * %lpkg.ama:Packages management (install/remove/update software)

 * %lnetwork.ama:Networking

 * %lnetwork.ama:Networking

 * %lfreedos.ama:SvarDOS vs FreeDOS: what is the story?

 * %lfreedos.ama:SvarDOS vs FreeDOS: what is the story?

 * %ltodo.ama:The project's "TODO" list

 * %ltodo.ama:The project's "TODO" list

 * %lcontact.ama:How do I get in touch with the SvarDOS community?

 * %lcontact.ama:How do I get in touch with the SvarDOS community?

 * %lmeaning.ama:What does "Svarog" mean?

 * %lhistory.ama:SvarDOS origins

==============================================================================

 * %lmeaning.ama:What does "Svarog" mean?

%hSvarDOS packages management

==============================================================================

To install or remove software on your SvarDOS system, use the "pkg" command.

%hSvarDOS packages management

pkg is a package manager to allow installing new software from SvarDOS

packages and removing exising software from the system. To learn about exact

To install or remove software on your SvarDOS system, use the "pkg" command.

pkg usage, type pkg /? in the SvarDOS command line shell.

pkg is a package manager to allow installing new software from SvarDOS

packages and removing exising software from the system. To learn about exact

You may obtain many SvarDOS packages from the SvarDOS web homepage at

pkg usage, type pkg /? in the SvarDOS command line shell.

<http://svardos.osdn.io>. If your system is connected to the internet, then

you may also use the SvarDOS "pkgnet" command. pkgnet is a network tool that

You may obtain many SvarDOS packages from the SvarDOS web homepage at

makes it easy to search for SvarDOS packages in the SvarDOS repository and

<http://svardos.osdn.io>. If your system is connected to the internet, then

download them right away. Type pkgnet /? in the SvarDOS command line shell to

you may also use the SvarDOS "pkgnet" command. pkgnet is a network tool that

learn about exact pkgnet usage.

makes it easy to search for SvarDOS packages in the SvarDOS repository and

download them right away. Type pkgnet /? in the SvarDOS command line shell to

See also:

learn about exact pkgnet usage.

 * %lpkgfmt.ama:The technical format of a SvarDOS package

 * %lpkgrules.ama:Packages inclusion rules

See also:

 * %lpkgfmt.ama:The technical format of a SvarDOS package

%hNetworking

 * %lpkgrules.ama:Packages inclusion rules

WRITE ME!

%hNetworking

SVARDOS HELP

WRITE ME!

%hHow do I get in touch with the project's community?

%hHow do I get in touch with the project's community?

The recommended way to contact the SvarDOS community is through the project's

mailing list: <https://lists.osdn.me/mailman/listinfo/svardos-users>

The recommended way to contact the SvarDOS community is through the project's

mailing list: <https://lists.osdn.me/mailman/listinfo/svardos-users>

The project's web homepage is <http://svardos.osdn.io>

The project's web homepage is <http://svardos.osdn.io>

Package files provide an easy way to manage software on SvarDOS. These

packages must adhere to a strict convention so they can be handled properly

Package files provide an easy way to manage software on SvarDOS. These

by the SvarDOS package manager.

packages must adhere to a strict convention so they can be handled properly

by the SvarDOS package manager.

%hPackage filenames

%hPackage filenames

Packages names must follow some basic rules. They shall be max. 8 letters long

(but should not be too short either, since a 1 or 2-letters package name might

Packages names must follow some basic rules. They shall be max. 8 letters long

be confusing), and must not be composed of characters other than a-b, 0-9 and

(but should not be too short either, since a 1 or 2-letters package name might

'_'. This for backward compatibility with short file names (8+3) and ISO 9660

be confusing), and must not be composed of characters other than a-b, 0-9 and

file systems (used on CDROMs). The package filename is always followed by the

'_'. This for backward compatibility with short file names (8+3) and ISO 9660

.ZIP extension.

file systems (used on CDROMs). The package filename is always followed by the

.ZIP extension.

%hPackage files

%hPackage files

SvarDOS uses ZIP files as its package file format. This format has been chosen

because ZIP files under DOS have become the de facto way to distribute

SvarDOS uses ZIP files as its package file format. This format has been chosen

collections of files. Also, the ZIP file format is well documented, well

because ZIP files under DOS have become the de facto way to distribute

supported, and in the public domain.

collections of files. Also, the ZIP file format is well documented, well

supported, and in the public domain.

Here below is the recommended command line that can be used to create a

package for a program named EXAMPLE using info-zip:

Here below is the recommended command line that can be used to create a

package for a program named EXAMPLE using info-zip:

  zip -9rk EXAMPLE.ZIP subdir1 subdir2 ... subdirN

  zip -9rk EXAMPLE.ZIP subdir1 subdir2 ... subdirN

If you are using 7za to create your packages, then use this:

If you are using 7za to create your packages, then use this:

  7za a -mm=deflate -mx=9 -tzip EXAMPLE.ZIP subdir1 subdir2 ... subdirN

  7za a -mm=deflate -mx=9 -tzip EXAMPLE.ZIP subdir1 subdir2 ... subdirN

%hPackage directory structure

%hPackage directory structure

The directory structure of a package depends on the type of packages.

For "core" packages, we have this:

The directory structure of a package depends on the type of packages.

For "core" packages, we have this:

  APPINFO            Put the program's LSM file here

  BIN                Binaries, such as exe and com files

  APPINFO            Put the program's LSM file here

  DOC\%PKGNAME%      Package documentation

  BIN                Binaries, such as exe and com files

  HELP               Used ONLY by the "help" package

  DOC\%PKGNAME%      Package documentation

  NLS\%PKGNAME%      Localizations (NLS language files) of the package

  HELP               Used ONLY by the "help" package

  SOURCE\%PKGNAME%   The source code (optional)

  NLS\%PKGNAME%      Localizations (NLS language files) of the package

  SOURCE\%PKGNAME%   The source code (optional)

Non-core packages use a slightly different directory organization. For

example, if we were to consider a package FOO, we might end up with the

Non-core packages use a slightly different directory organization. For

following structure:

example, if we were to consider a package FOO, we might end up with the

following structure:

  APPINFO\FOO.LSM    Package meta file for the FOO program

  PROGS\FOO\FOO.EXE  The program's executable

  APPINFO\FOO.LSM    Package meta file for the FOO program

  PROGS\FOO\FOO.TXT  Some documentation

  PROGS\FOO\FOO.EXE  The program's executable

  PROGS\FOO\FILE.DAT Data file used by the FOO program

  PROGS\FOO\FOO.TXT  Some documentation

  SOURCE\FOO\*       here would be stored the foo's source code (optional)

  PROGS\FOO\FILE.DAT Data file used by the FOO program

  SOURCE\FOO\*       here would be stored the foo's source code (optional)

Note the 'PROGS' directory above. This is a category to which the package

belong. The package installer might change this directory at install time,

Note the 'PROGS' directory above. This is a category to which the package

depending on the user's preferences. Possible categories are listed below:

belong. The package installer might change this directory at install time,

depending on the user's preferences. Possible categories are listed below:

Category | Description

DEVEL    | Development tools (mostly compilers)

Category | Description

DRIVERS  | Drivers

DEVEL    | Development tools (mostly compilers)

GAMES    | Games

DRIVERS  | Drivers

PROGS    | User programs, tools...

GAMES    | Games

PROGS    | User programs, tools...

Note: "DOC", "NLS", "BIN" and "HELP" directories are strictly reserved to

      CORE packages.

Note: "DOC", "NLS", "BIN" and "HELP" directories are strictly reserved to

      CORE packages.

%hLSM meta-data files

%hLSM meta-data files

Every package MUST contain an LSM file in its "APPINFO" directory. This LSM

file is a text file that contains basic information about the package. Its

Every package MUST contain an LSM file in its "APPINFO" directory. This LSM

format is very simple, it must contain at least two lines:

file is a text file that contains basic information about the package. Its

format is very simple, it must contain at least two lines:

  version: x.y.z

  description: package description

  version: x.y.z

  description: package description

Any other lines are ignored by the SvarDOS package manager.

Any other lines are ignored by the SvarDOS package manager.

                     %h*** Packages inclusion rules ***

                     %h*** Packages inclusion rules ***

SvarDOS is a DOS distribution that comes with plenty of third-party packages.

With time, packages get updated and new packages are being added. However,

SvarDOS is a DOS distribution that comes with plenty of third-party packages.

SvarDOS is not a shareware distribution CD, nor it is a "warez" production of

With time, packages get updated and new packages are being added. However,

any kind. Every software that is distributed within SvarDOS must comply to a

SvarDOS is not a shareware distribution CD, nor it is a "warez" production of

few common sense rules, as listed below.

any kind. Every software that is distributed within SvarDOS must comply to a

few common sense rules, as listed below.

%hObjective usefulness

%hObjective usefulness

The distributed software must be useful. There is no point in distributing

hundreds of "Hello World" programs for example. The software must be useable

The distributed software must be useful. There is no point in distributing

as a finished product and provide some features that are proven to be seeked

hundreds of "Hello World" programs for example. The software must be useable

by at least a subset of the user base. Games are considered useful, as long as

as a finished product and provide some features that are proven to be seeked

they fulfill their goal of providing actual distraction.

by at least a subset of the user base. Games are considered useful, as long as

they fulfill their goal of providing actual distraction.

%hReasonable quality

%hReasonable quality

The packaged program must exhibit traits of reasonable quality. This means

that it should have a deterministic behavior, and be free of undesirable

The packaged program must exhibit traits of reasonable quality. This means

side-effects to the user's computer (not crashing, freezing, resulting in

that it should have a deterministic behavior, and be free of undesirable

unexpected loss of data, etc). It should also provide clear, non-ambiguous

side-effects to the user's computer (not crashing, freezing, resulting in

instructions to the user about how the program is meant to be used.

unexpected loss of data, etc). It should also provide clear, non-ambiguous

instructions to the user about how the program is meant to be used.

%hFree (no cost)

%hFree (no cost)

The program must be free - that is, available at no financial cost. It doesn't

have to comply to an OSI-approved license or be open-source (even if that

The program must be free - that is, available at no financial cost. It doesn't

would be preferred), but at the very least it must be free for personal,

have to comply to an OSI-approved license or be open-source (even if that

non-commercial use.

would be preferred), but at the very least it must be free for personal,

non-commercial use.

%hDistribution allowed

%hDistribution allowed

The program must allow distribution without restrictions, and must not forbid

being redistributed in a re-packaged form.

The program must allow distribution without restrictions, and must not forbid

being redistributed in a re-packaged form.

%!CORE EXCEPTIONS

%!CORE EXCEPTIONS

Please note that, while the above rules are valid for all third-party packages

that may be distributed with SvarDOS, it does not apply to the 'core' packages

Please note that, while the above rules are valid for all third-party packages

that contain the operating system itself. SvarDOS being a free (as in "libre")

that may be distributed with SvarDOS, it does not apply to the 'core' packages

operating system, all "core" packages must comply to a libre-like license - be

that contain the operating system itself. SvarDOS being a free (as in "libre")

it GPL, BSD, MIT, public domain, or anything that allows for unrestricted

operating system, all "core" packages must comply to a libre-like license - be

distribution, provides source code and allows to modify it freely.

it GPL, BSD, MIT, public domain, or anything that allows for unrestricted

distribution, provides source code and allows to modify it freely.

%hSvarDOS licensing

%hSvarDOS licensing

SvarDOS is a DOS distribution made of many different software bricks, hence a

single license can hardly be applied to all. However, the CORE system (that

SvarDOS is a DOS distribution made of many different software bricks, hence a

is the SvarDOS installer, bootable floppy image and all core packages) is

single license can hardly be applied to all. However, the CORE system (that

carefully assembled from software that is "free" (as in "Freedom"), ie. that

is the SvarDOS installer, bootable floppy image and all core packages) is

grants the 3 basic FOSS liberties: freedom to use, modify, and redistribute.

carefully assembled from software that is "free" (as in "Freedom"), ie. that

This includes, but is not necessarily limited to, software released under

grants the 3 basic FOSS liberties: freedom to use, modify, and redistribute.

following licenses: GNU GPLv2, GNU GPLv3, BSD, MIT, EUPL and Public domain.

This includes, but is not necessarily limited to, software released under

following licenses: GNU GPLv2, GNU GPLv3, BSD, MIT, EUPL and Public domain.

Note that, while the above applies to the core of the SvarDOS distribution, it

does not cover all extra packages. Additionnal software packages may or may

Note that, while the above applies to the core of the SvarDOS distribution, it

not be FOSS, they are only guaranteed to be "gratis for non-commercial use".

does not cover all extra packages. Additionnal software packages may or may

not be FOSS, they are only guaranteed to be "gratis for non-commercial use".

Read more: %lpkgrules.ama:Packages inclusion rules

Read more: %lpkgrules.ama:Packages inclusion rules

%hWhat does "Svarog" mean?

%hWhat does "Svarog" mean?

The "Svar" in SvarDOS refers to "Svarog". SvarDOS is the successor of the

Svarog86 and Svarog386 distributions.

The "Svar" in SvarDOS refers to "Svarog". SvarDOS is the successor of the

Svarog86 and Svarog386 distributions.

Excerpt from Wikipedia, the free encyclopedia:

Excerpt from Wikipedia, the free encyclopedia:

 Svarog is a Slavic deity (...) identified with Hephaestus, the god of the

 blacksmith in ancient Greek religion (...), some researchers conclude that

 Svarog is a Slavic deity (...) identified with Hephaestus, the god of the

 Svarog is the Slavic god of celestial fire and of blacksmithing.

 blacksmith in ancient Greek religion (...), some researchers conclude that

 Svarog is the Slavic god of celestial fire and of blacksmithing.

 The only mention of Svarog comes from the Hypatian Codex, a 15th-century

 compilation of several much older documents from the Ipatiev Monastery in

 The only mention of Svarog comes from the Hypatian Codex, a 15th-century

 Russia. (...) The complete passage, reconstructed from several manuscripts,

 compilation of several much older documents from the Ipatiev Monastery in

 translates as follows:

 Russia. (...) The complete passage, reconstructed from several manuscripts,

 translates as follows:

 "(Then) began his reign Feosta (Hephaestus), whom the Egyptians called Svarog

  ... during his rule, from the heavens fell the smith's prongs and weapons

 "(Then) began his reign Feosta (Hephaestus), whom the Egyptians called Svarog

  were forged for the first time; before that, (people) fought with clubs and

  ... during his rule, from the heavens fell the smith's prongs and weapons

  stones."

  were forged for the first time; before that, (people) fought with clubs and

  stones."

%hSvarDOS: The project's TODO list

%hSvarDOS: The project's TODO list

* Replace the default (FreeDOS) edit with a smaller alternative (?)

  -> must be TINY

* Replace the default (FreeDOS) edit with a smaller alternative (?)

  -> no need for advanced text editing features, just enough to comfortably

  -> must be TINY

     edit small (<64K) configuration files

  -> no need for advanced text editing features, just enough to comfortably

  -> must be 8086-compatible and have modest memory requirements

     edit small (<64K) configuration files

  -> must be NLS-aware (multi-language)

  -> must be 8086-compatible and have modest memory requirements

  -> must be NLS-aware (multi-language)

* validate that CORE is 100% 8086-compatible

* validate that CORE is 100%% 8086-compatible

* build process: the install floppy should be built as much as possible using

  existing packages (ie. remove the custom "files" directory from svn)

* build process: the install floppy should be built as much as possible using

  existing packages (ie. remove the custom "files" directory from svn)

* Networking setup at install time -> should crynwr be part of the install

  set? Or only selected drivers? Or maybe this could be provided as a

* Networking setup at install time -> should crynwr be part of the install

  "supplemental" floppy disk?

  set? Or only selected drivers? Or maybe this could be provided as a

  "supplemental" floppy disk?

* bootable USB install image

* bootable USB install image

* add a "link" tool so users can easily create "links" to their favorite

  programs (esp. things like zip/unzip, etc)

* add a "link" tool so users can easily create "links" to their favorite

  programs (esp. things like zip/unzip, etc)

* pkg.exe: add an 'unzip' option so pkg.exe can be used as a poor man's unzip

* pkg.exe: add an 'unzip' option so pkg.exe can be used as a poor man's unzip

* install.com - MBR changes could be done by the installer itself instead of

  system()-calling fdisk

* install.com - MBR changes could be done by the installer itself instead of

  system()-calling fdisk

* help - write more useful content!

* help - write more useful content!

* further NLS support, improvements of existing translations and adding new

  languages -> would be nice to have some kind of web interface for submitting

* further NLS support, improvements of existing translations and adding new

  and reviewing translations

  languages -> would be nice to have some kind of web interface for submitting

  and reviewing translations

* pkgnet.exe: implement the 'checkup' action for easy update checking

* pkgnet.exe: implement the 'checkup' action for easy update checking

                        =============================

                          %hWanna help? %lcontact.ama:Get in touch!

                        =============================

                        =============================

                          %hWanna help? %lcontact.ama:Get in touch!

                        =============================

        %h*** Why would I want to use SvarDOS instead of FreeDOS? ***

        %h*** Why would I want to use SvarDOS instead of FreeDOS? ***

The FreeDOS project is a free, open-source operating system that aims to be

100%% compatible with MS-DOS. And it is awesome. So why would I want to use

The FreeDOS project is a free, open-source operating system that aims to be

SvarDOS instead?

100%% compatible with MS-DOS. And it is awesome. So why would I want to use

SvarDOS instead?

%hLong release cycles

%hLong release cycles

The FreeDOS project began 29 June 1994. Version 1.0 came around in 2006.

Version 1.1 has been released in 2012, and the version 1.2 followed in

The FreeDOS project began 29 June 1994. Version 1.0 came around in 2006.

December 2016. This translates roughly to a 5-years release cycle. Granted,

Version 1.1 has been released in 2012, and the version 1.2 followed in

the DOS scene is not as active as it used to be, but still, many things happen

December 2016. This translates roughly to a 5-years release cycle. Granted,

during a few years. Such version-centric approach also requires users to

the DOS scene is not as active as it used to be, but still, many things happen

perform full-system upgrades every now and then.

during a few years. Such version-centric approach also requires users to

perform full-system upgrades every now and then.

SvarDOS is very different in this regard: there are no versions at all.

Whenever a new program is included into or updated within the distribution, it

SvarDOS is very different in this regard: there are no versions at all.

becomes immediately available through the SvarDOS reposoitory and may be

Whenever a new program is included into or updated within the distribution, it

pulled either through the SvarDOS website or SvarDOS' pkgnet tool. Already

becomes immediately available through the SvarDOS reposoitory and may be

installed systems can be easily kept up-to-date using the distribution's

pulled either through the SvarDOS website or SvarDOS' pkgnet tool. Already

package manager.

installed systems can be easily kept up-to-date using the distribution's

package manager.

%hConstraints of legal nature

%hConstraints of legal nature

The FreeDOS project mimicks a proprietary operating system, with all its APIs

and peculiarities. For this reason, the project always had to be extremely

The FreeDOS project mimicks a proprietary operating system, with all its APIs

careful about what can and what cannot be included within the FreeDOS

and peculiarities. For this reason, the project always had to be extremely

distribution. As a result, only "free software" (as in freedom, think GPL,

careful about what can and what cannot be included within the FreeDOS

BSD, and so on) can make its way into the official distribution. While such

distribution. As a result, only "free software" (as in freedom, think GPL,

cautious approach is sane and legally safe, it is far from practical for

BSD, and so on) can make its way into the official distribution. While such

users. Allowing exclusively free software means that a high number of useful

cautious approach is sane and legally safe, it is far from practical for

programs, tools and games are left behind. For example "freeware" tools (as in

users. Allowing exclusively free software means that a high number of useful

"gratis but no source included") are a no-go. Even open-source programs can be

programs, tools and games are left behind. For example "freeware" tools (as in

rejected, if they do not clearly state that they comply with an OSI-approved

"gratis but no source included") are a no-go. Even open-source programs can be

license.

rejected, if they do not clearly state that they comply with an OSI-approved

license.

SvarDOS, on the other hand, is much more liberal about including packages.

Basically, anything that is objectively useful, of reasonable quality,

SvarDOS, on the other hand, is much more liberal about including packages.

free/gratis and can be legally distributed in the form of a package, can be

Basically, anything that is objectively useful, of reasonable quality,

included in SvarDOS. The only exception is for the "core" system (ie. the

free/gratis and can be legally distributed in the form of a package, can be

operating system itself), which must be based exclusively on free/libre

included in SvarDOS. The only exception is for the "core" system (ie. the

software. Read more about %lpkgrules.ama:SvarDOS package inclusion rules%t.

operating system itself), which must be based exclusively on free/libre

software. Read more about %lpkgrules.ama:SvarDOS package inclusion rules%t.

%hFreeDOS included!

%hFreeDOS included!

It must be noted, that altough the goals of SvarDOS and FreeDOS may be

slightly different, SvarDOS wouldn't exist without FreeDOS. Indeed, SvarDOS

It must be noted, that altough the goals of SvarDOS and FreeDOS may be

uses the excellent FreeDOS kernel, as well as a few other utilities borrowed

slightly different, SvarDOS wouldn't exist without FreeDOS. Indeed, SvarDOS

from the FreeDOS ecosystem.

uses the excellent FreeDOS kernel, as well as a few other utilities borrowed

from the FreeDOS ecosystem.

Read also: %lhistory.ama:SvarDOS history

%hSvarDOS origins (history from the point of view of its creator)

Mateusz Viste, the SvarDOS author, says:

In the years 2005-2015, I used to perform packaging work for the FreeDOS

project. I wasn't pleased with the packaging tool that FreeDOS used back then

(FDPKG), so in 2012 I started working on a new package manager, with network

support, automatic updates, etc - I named it FDNPKG. Later I also devised a

scripted way of generating an "always up to date" FreeDOS CD that I

unimaginatively called "all_cd.iso". This CD included FDNPKG and all the

FreeDOS packages available at the given moment.

I still wasn't satisfied with how FreeDOS clings to its notion of "releases"

and that it cannot include some software because of licensing issues, so in

2016 I decided to create my own distribution, that I called Svarog386 (there

was also a Svarog86 project that I had created a couple of months earlier,

dedicated to 8086 machines). Svarog386 naturally relied on the FreeDOS kernel

and used the FDNPKG package manager.

Then, in 2021, I started to be tired of having two separate distributions to

care about. Over time, FDNPKG also became a huge piece of protected mode code,

and although it was magnificent code, I was no longer happy with it: too many

features, too complex data processing, too high memory requirements... In a

word: too much fluff. I longed for something simpler, that would do perhaps

less, but with more transparency towards the user - and something that would

work in real mode with not much RAM, so it could be useful even on ancient

8086 machines.

The result of these thoughts was SvarDOS: a distribution that replaced both

Svarog86 and Svarog386, and that came with its own package manager - a much

simpler (and in my opinion much more elegant) tool than FDNPKG.

SVARDOS HELP SYSTEM ver 20210211