[Pkg-javascript-commits] [node-yarnpkg] 09/13: generate the manpage

[Paolo Greppi]

This is an automated email from the git hooks/post-receive script.

paolog-guest pushed a commit to branch master
in repository node-yarnpkg.

commit 2be6191a52bf592e3730ada3d887953a116e4675
Author: Paolo Greppi <paolo.greppi at libpf.com>
Date:   Sat Dec 24 13:57:02 2016 +0000

    generate the manpage
---
 debian/control          |  1 +
 debian/rules            |  8 ++++-
 debian/yarnpkg.manpages |  1 +
 debian/yarnpkg.md       | 94 +++++++++++++++++++++++++++++++++++++++++++++++++
 4 files changed, 103 insertions(+), 1 deletion(-)

diff --git a/debian/control b/debian/control
index 2c79172..ad9a175 100644
--- a/debian/control
+++ b/debian/control
@@ -6,6 +6,7 @@ Uploaders: Paolo Greppi <paolo.greppi at libpf.com>
 Build-Depends:
  debhelper (>= 9)
  , dh-buildinfo
+ , node-marked-man
  , nodejs
 Standards-Version: 3.9.8
 Homepage: https://github.com/yarnpkg/yarn#readme
diff --git a/debian/rules b/debian/rules
index 4d12009..bba619c 100755
--- a/debian/rules
+++ b/debian/rules
@@ -7,10 +7,16 @@
 %:
 	dh $@
 
-#override_dh_auto_build:
+override_dh_auto_build:
+	marked-man --version v0.18.1 --section 1 --manual 'yarnpkg man page' debian/yarnpkg.md > debian/yarnpkg.1
+	dh_auto_build
 
 override_dh_fixperms:
 	dh_fixperms
 	chmod +x debian/yarnpkg/usr/lib/nodejs/yarn/bin/yarn.js
 
+override_dh_clean:
+	dh_clean
+	rm -f debian/yarnpkg.1
+
 #override_dh_auto_test:
diff --git a/debian/yarnpkg.manpages b/debian/yarnpkg.manpages
new file mode 100644
index 0000000..a9b329d
--- /dev/null
+++ b/debian/yarnpkg.manpages
@@ -0,0 +1 @@
+debian/yarnpkg.1
diff --git a/debian/yarnpkg.md b/debian/yarnpkg.md
new file mode 100644
index 0000000..af68456
--- /dev/null
+++ b/debian/yarnpkg.md
@@ -0,0 +1,94 @@
+# yarnpkg - Fast, reliable and secure npm alternative
+
+## SYNOPSIS
+yarnpkg command [package]@[version]
+
+## DESCRIPTION
+Fast: Yarnpkg caches every package it downloads so it never needs to
+again. It also parallelizes operations to maximize resource utilization
+so install times are faster than ever.
+
+Reliable: Using a detailed, but concise, lockfile format, and a
+deterministic algorithm for installs, Yarnpkg is able to guarantee that
+an install that worked on one system will work exactly the same way on
+any other system.
+
+Secure: Yarnpkg uses checksums to verify the integrity of every
+installed package before its code is executed.
+
+## EXAMPLES
+Here are some of the most common commands you’ll need.
+
+Starting a new project
+```
+yarn init
+```
+
+Adding a dependency
+```
+yarn add [package]
+yarn add [package]@[version]
+yarn add [package]@[tag]
+```
+
+Updating a dependency
+```
+yarn upgrade [package]
+yarn upgrade [package]@[version]
+yarn upgrade [package]@[tag]
+```
+
+Removing a dependency
+```
+yarn remove [package]
+```
+
+Installing all the dependencies of project
+```
+yarn
+```
+
+or
+```
+yarn install
+```
+
+## COMMANDS
+Yarn provides a rich set of command-line commands to help you with various aspects of your Yarn package, including installation, administration, publishing, etc.
+
+Some of the more popular commands are:
+
+- `yarn add`: adds a package to use in your current package.
+
+- `yarn init`: initializes the development of a package.
+
+- `yarn install`: installs all the dependencies defined in a package.json file.
+
+- `yarn publish`: publishes a package to a package manager.
+
+- `yarn remove`: removes an unused package from your current package.
+
+### Default Command
+
+Running yarn with no command will run yarn install, passing through any provided flags.
+
+###Concurrency and --mutex
+
+When running multiple instances of yarn as the same user on the same server, you can ensure only one instance runs at any given time (and avoid conflicts) by passing the global flag --mutex followed by file or network.
+
+When using file Yarn will write/read a mutex file .yarn-single-instance in the current working directory by default. You can also specify an alternate or global filename.
+```
+--mutex file
+--mutex file:/tmp/.yarn-mutex
+```
+When using network Yarn will create a server at port 31997 by default. You can also specify an alternate port.
+```
+--mutex network
+--mutex network:30330
+```
+
+## AUTHOR
+The Yarn Contributors
+
+## COPYRIGHT
+This manual page was written by Paolo Greppi `<paolo.greppi at libpf.com>` for the Debian project (and may be used by others), based on material from the yarnpkg project itself.

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-javascript/node-yarnpkg.git