Export to GitHub

sfxr - issue #2

Manpage missing


Posted on Apr 3, 2010 by Happy Cat

Sfxr does not have a Unix manpage, usable with the 'man' commandline.

I have written a readme-like document in the asciidoc format, based on the readme.txt file. The Makefile can build a proper manpage from this document using a2x. However, this draws in a new dependency, something you might not want.

The benefits of the this patch (with the a2x dependency): - The source document is easily editable - The source document is also usable for Windows users - The current readme.txt can be replaced by the source document

Let me know if a preprocessed manpage is desired and I'll submit a new patch.

Attachments

Comment #1

Posted on Apr 3, 2010 by Happy Cat

Oops, I have mistakenly added some Subversion metadata changes to the patch. I have attached a version without this information.

Attachments

Comment #2

Posted on Apr 3, 2010 by Happy Wombat

I think a preprocessed manpage would be best for now. If you attach one, I'll commit it.

Comment #3

Posted on Apr 3, 2010 by Happy Cat

Here you go.

Note that the Makefile also has a slightly different clean-target. This is to prevent make from generating an error when cleaning without a sfxr-binary. It is too little a thing to raise a brand new bugreport over, but still something I want to point out.

Attachments

Comment #4

Posted on Apr 17, 2010 by Happy Wombat

The patch was applied. Thanks! I started working on autotools stuff, so I moved the Makefile to Makefile.backup so it doesn't conflict until the autotools method is fully functional and the old Makefile is integrated into it.

Comment #5

Posted on Apr 21, 2010 by Happy Cat

Since Autotools is Unix/Linux only, do you think it is a good idea to opt for a cross- platform build solution? If so, I would suggest CMake, as it is able to perform library detection just like autotools and outputs native build files (Visual Studio projects, XCode projects, Makefiles). On top of that, it can generate distribution packages for Windows, Mac and several Linux flavors.

What do you think?

Comment #6

Posted on Apr 22, 2010 by Happy Wombat

Ideally, making it fully cross-platform would be great. One could use Msys or Cygwin to run Autotools. We could also have a script specific to Windows. I'm not totally sold on Autotools, so if you contribute something, I would gladly replace my stuff.

Status: Fixed

Labels:
Type-Defect Priority-Medium