mirror of
https://github.com/balena-io/balena-cli.git
synced 2025-02-20 17:33:18 +00:00
Fix global *.roff installation issue
NPM refuses to install man pages that end in *.roff.
This commit is contained in:
parent
7ca78c5251
commit
3304e4bc98
@ -60,15 +60,15 @@ $ npm run-script doc
|
||||
|
||||
## Manual pages
|
||||
|
||||
UNIX manual pages reside in `doc/`
|
||||
UNIX manual pages reside in `man/`
|
||||
|
||||
You can regenerate UNIX `roff` manual pages from markdown with:
|
||||
|
||||
```sh
|
||||
$ npm run-script man
|
||||
$ gulp man
|
||||
```
|
||||
|
||||
If you add a new `man` page, remember to add the `roff` filename to the `man` array in `package.json`.
|
||||
If you add a new `man` page, remember to add the generated filename to the `man` array in `package.json`.
|
||||
|
||||
## Caveats
|
||||
|
||||
|
@ -1,16 +0,0 @@
|
||||
.\" Generated with Ronnjs 0.4.0
|
||||
.\" http://github.com/kapouer/ronnjs
|
||||
.
|
||||
.TH "RESIN" "1" "December 2014" "" ""
|
||||
.
|
||||
.SH "NAME"
|
||||
\fBresin\fR \-\- command line tool to interact with resin\.io
|
||||
.
|
||||
.SH "SYNOPSIS"
|
||||
\fBresin\fR [options] <command>
|
||||
.
|
||||
.SH "DESCRIPTION"
|
||||
\fBresin\fR is a powerful command line application to interact, develop and deploy resin\.io applications and devices\.
|
||||
.
|
||||
.SH "COPYRIGHT"
|
||||
resin is Copyright (C) 2014 Resin\.io \fIhttps://resin\.io\fR
|
@ -1,6 +1,7 @@
|
||||
path = require('path')
|
||||
gulp = require('gulp')
|
||||
mocha = require('gulp-mocha')
|
||||
markedMan = require('gulp-marked-man')
|
||||
coffeelint = require('gulp-coffeelint')
|
||||
mochaNotifierReporter = require('mocha-notifier-reporter')
|
||||
|
||||
@ -12,6 +13,14 @@ OPTIONS =
|
||||
app: [ 'lib/**/*.coffee', '!lib/**/*.spec.coffee' ]
|
||||
tests: 'lib/**/*.spec.coffee'
|
||||
json: 'lib/**/*.json'
|
||||
man: 'man/**/*.md'
|
||||
directories:
|
||||
man: 'man/'
|
||||
|
||||
gulp.task 'man', ->
|
||||
gulp.src(OPTIONS.files.man)
|
||||
.pipe(markedMan())
|
||||
.pipe(gulp.dest(OPTIONS.directories.man))
|
||||
|
||||
gulp.task 'test', ->
|
||||
gulp.src(OPTIONS.files.tests, read: false)
|
||||
@ -26,5 +35,12 @@ gulp.task 'lint', ->
|
||||
}))
|
||||
.pipe(coffeelint.reporter())
|
||||
|
||||
gulp.task 'build', [
|
||||
'lint'
|
||||
'test'
|
||||
'man'
|
||||
]
|
||||
|
||||
gulp.task 'watch', [ 'test', 'lint' ], ->
|
||||
gulp.watch([ OPTIONS.files.coffee, OPTIONS.files.json ], [ 'test', 'lint' ])
|
||||
gulp.watch([ OPTIONS.files.man ], [ 'man' ])
|
||||
|
@ -1,69 +1,48 @@
|
||||
.\" Generated with Ronnjs 0.4.0
|
||||
.\" http://github.com/kapouer/ronnjs
|
||||
.
|
||||
.TH "RESIN" "1" "December 2014" "" ""
|
||||
.
|
||||
.SH "NAME"
|
||||
\fBresin\fR \-\- tab completion for resin
|
||||
.
|
||||
.SH "DESCRIPTION"
|
||||
It provides basic completion capabilities for \fBzsh\fR and \fBbash\fR\|\.o
|
||||
.
|
||||
\fBresin\fR \- tab completion for resin
|
||||
.SH DESCRIPTION
|
||||
.P
|
||||
If you\'re using \fBbash\fR, add the following line to your \fB~/\.bashrc\fR:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
It provides basic completion capabilities for \fBzsh\fR and \fBbash\fR\|\.o
|
||||
.P
|
||||
If you're using \fBbash\fR, add the following line to your \fB~/\.bashrc\fR:
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
\|\. /path/to/resin/completion/resin\.sh\.
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.RE
|
||||
.P
|
||||
or create a symlink like this if you have automatic bash completion set up:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
ln \- /path/to/resin/completion/resin\.sh /etc/bash\-completion\.d/resin
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.RE
|
||||
.P
|
||||
or, perhaps:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
ln \- /path/to/resin/completion/resin\.sh /usr/local/etc/bash\-completion\.d/resin
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.RE
|
||||
.P
|
||||
If you\'re using \fBzsh\fR, add the following to your \fB~/\.zshrc\fR:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
If you're using \fBzsh\fR, add the following to your \fB~/\.zshrc\fR:
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
autoload bashcompinit
|
||||
bashcompinit
|
||||
source /path/to/resin/completion/resin\.sh
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.SH "RESIN PATH"
|
||||
.RE
|
||||
.SH RESIN PATH
|
||||
.P
|
||||
\fB/path/to/resin\fR refers to the place where resin was globally installed in your system\.
|
||||
.
|
||||
.P
|
||||
This is usually something like \fB/usr/lib/node_modules/resin\fR, or \fBC:\\Users\\AppData\\Roaming\\npm\\node_modules\\resin\fR on Windows\.
|
||||
.
|
||||
.SH "COPYRIGHT"
|
||||
resin is Copyright (C) 2014 Resin\.io \fIhttps://resin\.io\fR
|
||||
.SH COPYRIGHT
|
||||
.P
|
||||
resin is Copyright (C) 2014 Resin\.io https://resin\.io
|
12
man/resin.1
Normal file
12
man/resin.1
Normal file
@ -0,0 +1,12 @@
|
||||
.TH "RESIN" "1" "December 2014" "" ""
|
||||
.SH "NAME"
|
||||
\fBresin\fR \- command line tool to interact with resin\.io
|
||||
.SH SYNOPSIS
|
||||
.P
|
||||
\fBresin\fR [options] <command>
|
||||
.SH DESCRIPTION
|
||||
.P
|
||||
\fBresin\fR is a powerful command line application to interact, develop and deploy resin\.io applications and devices\.
|
||||
.SH COPYRIGHT
|
||||
.P
|
||||
resin is Copyright (C) 2014 Resin\.io https://resin\.io
|
@ -9,15 +9,14 @@
|
||||
},
|
||||
"preferGlobal": true,
|
||||
"man": [
|
||||
"./doc/resin.1.roff",
|
||||
"./doc/resin-completion.1.roff"
|
||||
"./man/resin.1",
|
||||
"./man/resin-completion.1"
|
||||
],
|
||||
"bin": {
|
||||
"resin": "./bin/resin"
|
||||
},
|
||||
"scripts": {
|
||||
"test": "cult test",
|
||||
"man": "ronn --build --roff doc/*.md",
|
||||
"doc": "codo -o ./doc/codo `find lib/resin -name \"*.coffee\" | grep -v \"spec.coffee$\"`"
|
||||
},
|
||||
"keywords": [
|
||||
@ -46,7 +45,9 @@
|
||||
"run-sequence": "~1.0.2",
|
||||
"chai-string": "~1.1.0",
|
||||
"codo": "~2.0.9",
|
||||
"ronn": "~0.4.0"
|
||||
"ronn": "~0.4.0",
|
||||
"through2": "~0.6.3",
|
||||
"gulp-marked-man": "~0.3.1"
|
||||
},
|
||||
"dependencies": {
|
||||
"request": "~2.47.0",
|
||||
|
Loading…
x
Reference in New Issue
Block a user