Get that Linux feeling - on Windows

Cygwin Package Contributor's Guide

This document is intended for people who upload packages to, to be made available through the standard Cygwin setup program.


Making a package with cygport

While older, hand-made packages exist, the only accepted way to make a new Cygwin package is using the cygport tool, which automatically handles most packaging requirements and issues for you. It is also strongly recommended to convert existing packages to cygport when updating them; ask on the cygwin-apps list if you need help converting an existing package to use cygport.

The cygport framework improves on previous Cygwin build scripts, and borrows concepts from the Gentoo portage system.

Suppose that the upstream's boffo-1.0.tar.xz source tar file, that you downloaded from the boffo homepage, unpacks into boffo-1.0/.

Further, suppose you've got boffo ported to Cygwin. It took some work, but you've got a patch file, which we will name boffo-1.0-fix-whatever.patch, and with that applied boffo builds and runs.

All that remains is to write a boffo.cygport file which will describe how to unpack, configure, build and package:

# package name

# .hint generation
SUMMARY="A whackamole simulation in ASCII art"
DESCRIPTION="A whackamole simulation in ASCII art.
Intended for use on VT100 terminals at BAUD rates 1200 and
above.  Uses arrow keys for positioning over moles.  Space
bar whacks the mole.
No actual moles will be harmed during execution of this game."

# source and patch files

# use the standard src_compile, src_install and src_test

The source and binary packages can then be built and a .hint generated by running cygport, e.g.

$ cygport boffo.cygport fetch
--2017-04-01 11:59:59--
Connecting to||:80... connected.
HTTP request sent, awaiting response... 200 OK
Length: 352 [application/x-tar]
Saving to: ‘boffo-1.0.tar.xz.tmp’

boffo-1.0.tar.xz.tmp 100%[===================>]     352  --.-KB/s    in 0s

2017-04-01 11:59:59 (8.06 MB/s) - ‘boffo-1.0.tar.xz.tmp’ saved [352/352]

$ cygport boffo.cygport all
>>> Preparing boffo-1.0-1.x86_64
>>> Unpacking source boffo-1.0.tar.xz
*** Info: applying patch boffo-1.0-fix-whatever.patch:
>>> Preparing working source directory
>>> Compiling boffo-1.0-1.x86_64
>>> Installing boffo-1.0-1.x86_64
Fixing symlinks:
Stripping executables:
Preparing debuginfo source files:
        1 files
>>> Packaging boffo-1.0-1.x86_64
>>> Creating binary package(s)
>>> boffo-1.0-1.tar.xz

>>> boffo-debuginfo-1.0-1.tar.xz

>>> Checking packages for missing or duplicate files

>>> Creating source patches
 0 files changed
>>> Creating source package

>>> boffo requires: cygwin libncursesw10

For more information on using cygport consult the man page, README, reference manual and sample .cygport files.

Locally installing your package for testing

Unfortunately, there is no tool for directly installing package files, at the moment. Two common techniques to achieve this:

Marking your package as a test version

Packages can be marked as test versions, which are not offered for installation by setup unless the use of test packages has been opted-into, by using cygport all-test, rather than cygport all. Building the packages in that way adds a test: hint.

Submitting a new package

So you've got a package you want to submit. Follow the following checklist before emailing the cygwin-apps mailing list, and you'll almost certainly save time.

Uploading an accepted package

Updating a package

So you've got an updated package. You should already have upload privileges, and should be able to do the entire process yourself.

NOTE: On any major version upgrade, you may want to mark the release as test.

Composing an announcement mail

cygport announce can help you compose and send an announcement mail, based on the following template.

Subject: foo-0.30.2-1

The following packages have been uploaded to the Cygwin distribution:

* foo 0.30.2-1

(a couple of lines about what "foo" is)
(short changelog of important features or fixes; big emphasis for security fixes)
(paths or links to installed and online changelogs, with more details)



If you want to unsubscribe from the cygwin-announce mailing list, look at the "List-Unsubscribe:" tag in the email header of this message. Send email to the address specified there. It will be in the format:<at>

If you need more information on unsubscribing, start reading here:

Be sure the unsubscribe instructions are included at the end of the email, since cygwin-announce does not add any.

Once sent, your message will be reviewed by one of the cygwin-announce moderators and, once approved, will be automatically forwarded to the cygwin mailing list with [ANNOUNCEMENT] prepended to the subject.