cli-setup: Helper setup scripts for packaging command-line tools.

[ bsd3, command-line-tools, development, library ] [ Propose Tags ]

Provides functions to set up manpages and shell completions. Intended to be used in the Setup.hs module.


[Skip to Readme]

Modules

[Index]

Flags

Manual Flags

NameDescriptionDefault
development

Enable `-Werror`

Disabled

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Note: This package has metadata revisions in the cabal description newer than included in the tarball. To unpack the package including the revisions, use 'cabal get'.

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

  • No Candidates
Versions [RSS] 0.1.0.0, 0.1.0.1, 0.1.0.2, 0.1.0.3, 0.2.0.0, 0.2.0.1, 0.2.0.2, 0.2.0.3, 0.2.0.4, 0.2.0.5, 0.2.0.6, 0.2.0.7, 0.2.1.0, 0.2.1.1, 0.2.1.2, 0.2.1.3, 0.2.1.4 (info)
Dependencies base (>=4.8 && <5), bytestring, directory, file-embed (>=0.0.9), process (>=1.4.0.0) [details]
License BSD-3-Clause
Copyright Copyright: (c) 2018 Vanessa McHale
Author Vanessa McHale
Maintainer vamchale@gmail.com
Revised Revision 1 made by vmchale at 2018-03-30T20:28:26Z
Category Development, Command Line Tools
Home page https://github.com/vmchale/cli-setup#readme
Source repo head: darcs get https://hub.darcs.net/vmchale/cli-setup
Uploaded by vmchale at 2018-02-02T05:53:57Z
Distributions NixOS:0.2.1.4
Reverse Dependencies 1 direct, 0 indirect [details]
Downloads 8577 total (23 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2018-02-02 [all 1 reports]

Readme for cli-setup-0.2.0.1

[back to package description]

cli-setup

Example use taken from madlang's `Setup.hs` file:

import           Distribution.CommandLine
import           Distribution.Simple

main :: IO ()
main = setManpath >>
    writeManpages "man/madlang.1" "madlang.1" >>
    writeBashCompletions "madlang" >>
    defaultMain

Be sure to add man/madlang.1 (or whatever the path to your source file is) to your .cabal file's extra-source-files field.