Write a manpage
authorJoachim Breitner <joachim.breitner@itomig.de>
Fri, 12 Jun 2009 10:53:43 +0000 (10:53 +0000)
committerJoachim Breitner <joachim.breitner@itomig.de>
Fri, 12 Jun 2009 10:53:43 +0000 (10:53 +0000)
debian/control
debian/manpages [new file with mode: 0644]
wine-app-packager
wine-app-packager.1 [new file with mode: 0644]

index b3407a8..bd1f929 100644 (file)
@@ -8,7 +8,7 @@ Standards-Version: 3.8.1
 Package: wine-app-packager
 Architecture: all
 Depends: ${shlibs:Depends}, ${misc:Depends}
-Description: helps you creating Debian packages for Windows program
+Description: helps you creating Debian packages for Windows programs
  This script guides you in wrapping a Windows program in a Debian package,
  based on wine. It will create a template Debian source package for you and
  include the C:\ directory tree of your program.
diff --git a/debian/manpages b/debian/manpages
new file mode 100644 (file)
index 0000000..02bd1c8
--- /dev/null
@@ -0,0 +1 @@
+wine-app-packager.1
index 7222744..0d007ff 100755 (executable)
@@ -68,7 +68,7 @@ wine-app-packager run <cmd>
 wine-app-packager commit
        Takes the changes you made in ~/.wine-<application>-master and puts them
        back into the Debian source package. Ususally, this will be followed by
-       calls to debchange and debuilt to build the package
+       calls to debchange and debuild to build the package.
        Removes ~/.wine-<application>-master afterwards.
 
 wine-app-packager abort
diff --git a/wine-app-packager.1 b/wine-app-packager.1
new file mode 100644 (file)
index 0000000..717f20c
--- /dev/null
@@ -0,0 +1,74 @@
+.TH WINE-APP-PACKAGER "1" "June 2009" "wine-app-packager 0.1" "User Commands"
+.SH NAME
+wine-app-packager \- helps you creating Debian packages for Windows programs
+.SH SYNOPSIS
+.B wine-app-packager\fR init
+.PP
+.B wine-app-packager\fR prepare
+.PP
+.B wine-app-packager\fR run \fI<cmd>\fR
+.PP
+.B wine-app-packager\fR commit
+.PP
+.B wine-app-packager\fR abort
+.PP
+.SH DESCRIPTION
+.B wine-app-packager
+guides you in wrapping a Windows program in a Debian package,
+based on wine. It will create a template Debian source package for you and
+include the \fIC:\\\fR directory tree of your program.
+.SH OPTIONS
+.TP
+.B wine-app-packager\fR init
+creates a Debian source package directory. It will ask various pieces
+of information. All the following commands will need to run within the
+created directory.
+
+.TP
+.B wine-app-packager\fR prepare
+creates a wine config directory in \fI~/.wine-<application>-master\fR, based on
+the current content of the package (if any).
+
+.TP
+.B wine-app-packager\fR run \fI<cmd>\fR
+runs \fR<cmd>\fR in a way that \fBWINEPREFIX\fR is set correctly, i.e.
+.nf
+wine-app-packager run wine /tmp/install.exe
+.fi
+or
+.nf
+wine-app-packager run wine C:\\\\Applications\\\\DemoApplication\\\\DemoApplication.exe
+.fi
+
+.TP
+.B wine-app-packager\fR commit
+takes the changes you made in \fI~/.wine-<application>-master\fR and puts them
+back into the Debian source package. Ususally, this will be followed by
+calls to \fBdebchange\fR and \fBdebuild\fR to build the package.
+Removes \fI~/.wine-<application>-master\fR afterwards.
+
+.TP
+.B wine-app-packager\fR abort
+Just removes \fI~/.wine-<application>-master\fR, throwing away all changes.
+
+.SH "EXAMPLES"
+
+A typical run of \fBwine-app-packager\fR that creates a new package, builds it and run the program would look like this (only user input shown):
+.PP
+.nf
+$ wine-app-packager init
+7z
+1.2.3
+$ cd 7z-1.2.3
+$ wine-app-packager prepare
+$ wine-app-packager run /tmp/7z465.exe
+$ wine-app-packager commit
+$ edit ./z7 # set the EXE= variable
+$ debuild -uc -us
+$ sudo debi
+$ 7z
+.fi
+
+.SH AUTHOR
+Joachim Breitner <joachim.breitner@itomig.de>
+