Last active
December 6, 2018 13:28
-
-
Save Alhadis/0211a1cfc77e1ff4bd5a4f8f5e32b0d4 to your computer and use it in GitHub Desktop.
Manpage previews
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
<!DOCTYPE html><html lang="en"><head><meta charset="UTF-8"/><title>Preview</title><style> html{ background: black; color: white } a{ color: inherit; text-decoration: none } pre{ font: 10px Menloco, Monaco, Menlo, monospace; font-variant-ligatures: none }</style></head><body><pre> | |
ATOM(1) General Commands Manual ATOM(1) | |
<b>NAME</b> | |
atom — a hackable text editor for the 21st century | |
<b>SYNOPSIS</b> | |
<b>atom</b> [<u>options</u>] [<u>paths...</u>] | |
<b>DESCRIPTION</b> | |
Opens one or more <u>paths</u> in Atom, which may point to either files or | |
folders. | |
If there is an existing Atom window that contains all of the given | |
folders, the paths will be opened in that window. Otherwise, they will | |
be opened in a new window. | |
Paths that start with “atom://” will be interpreted as URLs. | |
<b>OPTIONS</b> | |
<b>-1</b>, <b>--one</b> | |
This option is no longer supported. It was formerly used to | |
preview v1.0 APIs, and became redundant once Atom v1.0 shipped. | |
<b>-a</b>, <b>--add</b> | |
Open path as a new project in last used window. | |
<b>--benchmark</b> | |
Open a new window that runs the specified benchmarks. | |
<b>--benchmark-test</b> | |
Run a faster version of the benchmarks in headless mode. | |
<b>--clear-window-state</b> | |
Delete all Atom environment state. | |
<b>-d</b>, <b>--dev</b> | |
Run in development mode. | |
<b>--enable-electron-logging</b> | |
Enable low-level logging messages from Electron. | |
<b>-f</b>, <b>--foreground</b> | |
Keep the main process in the foreground. | |
<b>-h</b>, <b>--help</b> | |
Print a usage message. | |
<b>--include-deprecated-apis</b> | |
This option is not currently supported. | |
<b>-l</b>, <b>--log-file</b> <u>file</u> | |
Log all output to <u>file</u>. | |
<b>-m</b>, <b>--main-process</b> | |
Run the specified specs in the main process. | |
<b>-n</b>, <b>--new-window</b> | |
Open a new window. | |
<b>-p</b>, <b>--project</b> <u>file</u> | |
Start Atom with a project specification <u>file</u>, which may be | |
either CSON or JSON. | |
<b>--profile-startup</b> | |
Create a profile of the startup execution time. | |
<b>-r</b>, <b>--resource-path</b> <u>path</u> | |
Set the path to the Atom source directory and enable dev-mode. | |
<b>--safe</b> Do not load packages from <u>~/.atom/packages</u> or <u>~/.atom/dev/pack-</u> | |
<u>ages</u>. | |
<b>-t</b>, <b>--test</b> <u>specs</u> | |
Run the specified <u>specs</u> and exit with an error code on failure. | |
<b>--timeout</b> <u>delay</u> | |
When in test mode, waits until the specified time (in minutes) | |
and kills the process (exit code: 130). | |
<b>-v</b>, <b>--version</b> | |
Print the version information. | |
<b>-w</b>, <b>--wait</b> | |
Wait for window to be closed before returning. | |
<b>ENVIRONMENT VARIABLES</b> | |
<b>ATOM_DEV_RESOURCE_PATH</b> | |
The path from which Atom loads source code in dev-mode. Defaults | |
to <u>~/github/atom</u>. | |
<b>ATOM_HOME</b> | |
The root path for all configuration files and folders. Defaults | |
to <u>~/.atom</u>. | |
<b>SEE ALSO</b> | |
<a href="man://apm/1"><b>apm</b>(1)</a> | |
The Atom flight manual: <u>http://flight-manual.atom.io/</u> | |
<b>AUTHORS</b> | |
Copyright © 2011–2017, GitHub Inc. Released under the MIT license. | |
Manpage written by Alhadis <<u><a href="mailto:gardnerjohng@gmail.com">gardnerjohng@gmail.com</a></u>>. | |
v1.16.0 ATOM(1) | |
</pre></body></html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
<!DOCTYPE html><html lang="en"><head><meta charset="UTF-8"/><title>Preview</title><style> html{ background: black; color: white } a{ color: inherit; text-decoration: none } pre{ font: 10px Menloco, Monaco, Menlo, monospace; font-variant-ligatures: none }</style></head><body><pre> | |
MAIL(1) User Commands MAIL(1) | |
<b>NAME</b> | |
mail − manual page for mail (GNU Mailutils) | |
<b>SYNOPSIS</b> | |
<b>mail</b> [<u>OPTION</u>...] [<u>address</u>...] | |
<b>DESCRIPTION</b> | |
GNU mail <b>−−</b> the standard /bin/mail interface | |
<b>REPORTING BUGS</b> | |
Report bugs to <<a href="mailto:bug-mailutils@gnu.org">bug-mailutils@gnu.org</a>>. | |
<b>SEE ALSO</b> | |
The full documentation for <b>mail</b> is maintained as a Texinfo manual. If | |
the <b>info</b> and <b>mail</b> programs are properly installed at your site, the | |
command | |
<b>info mail</b> | |
should give you access to the complete manual. | |
FSF MAIL(1) | |
</pre></body></html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
<!DOCTYPE html><html lang="en"><head><meta charset="UTF-8"/><title>Preview</title><style> html{ background: black; color: white } a{ color: inherit; text-decoration: none } pre{ font: 10px Menloco, Monaco, Menlo, monospace; font-variant-ligatures: none }</style></head><body><pre> | |
NODE(1) BSD General Commands Manual NODE(1) | |
<b>NAME</b> | |
<b>node</b> — server-side JavaScript runtime | |
<b>SYNOPSIS</b> | |
<b>node</b> [<u>options</u>] [<u>v8-options</u>] [<b>-e</b> <u>string</u> | <u>script.js</u> | <b>-</b>] [<b>--</b>] | |
[<u>arguments</u> <u>...</u>] | |
<b>node debug</b> [<b>-e</b> <u>string</u> | <u>script.js</u> | <b>-</b> | <u><host>:<port></u>] <u>...</u> | |
<b>node</b> [<b>--v8-options</b>] | |
<b>DESCRIPTION</b> | |
Node.js is a set of libraries for JavaScript which allows it to be used | |
outside of the browser. It is primarily focused on creating simple, | |
easy-to-build network clients and servers. | |
Execute <b>node</b> without arguments to start a REPL. | |
<b>OPTIONS</b> | |
<b>-</b> Alias for stdin, analogous to the use of - in other command-line | |
utilities. The executed script is read from stdin, and remaining | |
arguments are passed to the script. | |
<b>--</b> Indicate the end of node options. Pass the rest of the arguments | |
to the script. | |
If no script filename or eval/print script is supplied prior to | |
this, then the next argument will be used as a script filename. | |
<b>--abort-on-uncaught-exception</b> | |
Aborting instead of exiting causes a core file to be generated | |
for analysis. | |
<b>--enable-fips</b> | |
Enable FIPS-compliant crypto at startup. Requires Node.js to be | |
built with <b>./configure --openssl-fips</b>. | |
<b>--experimental-modules</b> | |
Enable experimental ES module support and caching modules. | |
<b>--experimental-repl-await</b> | |
Enable experimental top-level <b>await</b> keyword support in REPL. | |
<b>--experimental-vm-modules</b> | |
Enable experimental ES module support in VM module. | |
<b>--force-fips</b> | |
Force FIPS-compliant crypto on startup (Cannot be disabled from | |
script code). Same requirements as <b>--enable-fips</b>. | |
<b>--icu-data-dir</b>=<u>file</u> | |
Specify ICU data load path. Overrides NODE_ICU_DATA. | |
<b>--inspect-brk</b>=<u>[host:]port</u> | |
Activate inspector on <u>host:port</u> and break at start of user | |
script. | |
<b>--inspect-port</b>=<u>[host:]port</u> | |
Set the <u>host:port</u> to be used when the inspector is activated. | |
<b>--inspect</b>=<u>[host:]port</u> | |
Activate inspector on <u>host:port</u>. Default is <b>127.0.0.1:9229</b>. | |
V8 Inspector integration allows attaching Chrome DevTools and | |
IDEs to Node.js instances for debugging and profiling. It uses | |
the Chrome DevTools Protocol. | |
<b>--napi-modules</b> | |
This option is a no-op. It is kept for compatibility. | |
<b>--no-deprecation</b> | |
Silence deprecation warnings. | |
<b>--no-force-async-hooks-checks</b> | |
Disable runtime checks for `async_hooks`. These will still be | |
enabled dynamically when `async_hooks` is enabled. | |
<b>--no-warnings</b> | |
Silence all process warnings (including deprecations). | |
<b>--openssl-config</b>=<u>file</u> | |
Load an OpenSSL configuration file on startup. Among other uses, | |
this can be used to enable FIPS-compliant crypto if Node.js is | |
built with <b>./configure --openssl-fips</b>. | |
<b>--pending-deprecation</b> | |
Emit pending deprecation warnings. | |
<b>--preserve-symlinks</b> | |
Instructs the module loader to preserve symbolic links when | |
resolving and caching modules other than the main module. | |
<b>--preserve-symlinks-main</b> | |
Instructs the module loader to preserve symbolic links when | |
resolving and caching the main module. | |
<b>--prof-process</b> | |
Process V8 profiler output generated using the V8 option <b>--prof</b>. | |
<b>--redirect-warnings</b>=<u>file</u> | |
Write process warnings to the given <u>file</u> instead of printing to | |
stderr. | |
<b>--throw-deprecation</b> | |
Throw errors for deprecations. | |
<b>--tls-cipher-list</b>=<u>list</u> | |
Specify an alternative default TLS cipher list. Requires Node.js | |
to be built with crypto support. (Default) | |
<b>--trace-deprecation</b> | |
Print stack traces for deprecations. | |
<b>--trace-event-categories</b> <u>categories</u> | |
A comma-separated list of categories that should be traced when | |
trace event tracing is enabled using <b>--trace-events-enabled</b>. | |
<b>--trace-event-file-pattern</b> <u>pattern</u> | |
Template string specifying the filepath for the trace event data, | |
it supports <b>${rotation}</b> and <b>${pid}</b>. | |
<b>--trace-events-enabled</b> | |
Enable the collection of trace event tracing information. | |
<b>--trace-sync-io</b> | |
Print a stack trace whenever synchronous I/O is detected after | |
the first turn of the event loop. | |
<b>--trace-warnings</b> | |
Print stack traces for process warnings (including deprecations). | |
<b>--track-heap-objects</b> | |
Track heap object allocations for heap snapshots. | |
<b>--use-bundled-ca</b>, <b>--use-openssl-ca</b> | |
Use bundled Mozilla CA store as supplied by current Node.js ver- | |
sion or use OpenSSL's default CA store. The default store is | |
selectable at build-time. | |
The bundled CA store, as supplied by Node.js, is a snapshot of | |
Mozilla CA store that is fixed at release time. It is identical | |
on all supported platforms. | |
Using OpenSSL store allows for external modifications of the | |
store. For most Linux and BSD distributions, this store is main- | |
tained by the distribution maintainers and system administrators. | |
OpenSSL CA store location is dependent on configuration of the | |
OpenSSL library but this can be altered at runtime using environ- | |
ment variables. | |
See SSL_CERT_DIR and SSL_CERT_FILE. | |
<b>--v8-options</b> | |
Print V8 command-line options. | |
Note: V8 options allow words to be separated by both dashes (<b>-</b>) | |
or underscores (<b>_</b>). | |
For example, <b>--stack-trace-limit</b> is equivalent to | |
<b>--stack_trace_limit</b>. | |
<b>--v8-pool-size</b>=<u>num</u> | |
Set V8's thread pool size which will be used to allocate back- | |
ground jobs. If set to 0 then V8 will choose an appropriate size | |
of the thread pool based on the number of online processors. If | |
the value provided is larger than V8's maximum, then the largest | |
value will be chosen. | |
<b>--zero-fill-buffers</b> | |
Automatically zero-fills all newly allocated Buffer and Slow- | |
Buffer instances. | |
<b>-c</b>, <b>--check</b> | |
Check the script's syntax without executing it. Exits with an | |
error code if script is invalid. | |
<b>-e</b>, <b>--eval</b> <u>string</u> | |
Evaluate <u>string</u> as JavaScript. | |
<b>-h</b>, <b>--help</b> | |
Print node command line options. The output of this option is | |
less detailed than this document. | |
<b>-i</b>, <b>--interactive</b> | |
Open the REPL even if stdin does not appear to be a terminal. | |
<b>-p</b>, <b>--print</b> <u>string</u> | |
Identical to <b>-e</b>, but prints the result. | |
<b>-r</b>, <b>--require</b> <u>module</u> | |
Preload the specified <u>module</u> at startup. Follows `require()`'s | |
module resolution rules. <u>module</u> may be either a path to a file, | |
or a node module name. | |
<b>-v</b>, <b>--version</b> | |
Print node's version. | |
<b>ENVIRONMENT</b> | |
NODE_DEBUG <u>modules...</u> | |
Comma-separated list of core modules that should print debug | |
information. | |
NODE_DISABLE_COLORS | |
When set to <u>1</u>, colors will not be used in the REPL. | |
NODE_EXTRA_CA_CERTS <u>file</u> | |
When set, the well-known “root” CAs (like VeriSign) will be | |
extended with the extra certificates in <u>file</u>. The file should | |
consist of one or more trusted certificates in PEM format. | |
If <u>file</u> is missing or misformatted, a message will be emitted | |
once using <b>process.emitWarning()</b>, but any errors are otherwise | |
ignored. | |
NODE_ICU_DATA <u>file</u> | |
Data path for ICU (Intl object) data. Will extend linked-in data | |
when compiled with small-icu support. | |
NODE_NO_WARNINGS | |
When set to <u>1</u>, process warnings are silenced. | |
NODE_OPTIONS <u>options...</u> | |
A space-separated list of command-line <u>options</u>, which are inter- | |
preted as if they had been specified on the command-line before | |
the actual command (so they can be overridden). Node will exit | |
with an error if an option that is not allowed in the environment | |
is used, such as <b>--print</b> or a script file. | |
NODE_PATH <u>directories...</u> | |
A colon-separated list of <u>directories</u> prefixed to the module | |
search path. | |
NODE_PENDING_DEPRECATION | |
When set to <u>1</u>, emit pending deprecation warnings. | |
NODE_REDIRECT_WARNINGS <u>file</u> | |
Write process warnings to the given <u>file</u> instead of printing to | |
stderr. Equivalent to passing <b>--redirect-warnings</b> <u>file</u> on com- | |
mand-line. | |
NODE_REPL_HISTORY <u>file</u> | |
Path to the <u>file</u> used to store persistent REPL history. The | |
default path is <b>~/.node_repl_history</b>, which is overridden by this | |
variable. Setting the value to an empty string ("" or " ") will | |
disable persistent REPL history. | |
OPENSSL_CONF <u>file</u> | |
Load an OpenSSL configuration file on startup. Among other uses, | |
this can be used to enable FIPS-compliant crypto if Node.js is | |
built with <b>./configure --openssl-fips</b>. | |
If the <b>--openssl-config</b> command-line option is used, this envi- | |
ronment variable is ignored. | |
SSL_CERT_DIR <u>dir</u> | |
If <b>--use-openssl-ca</b> is enabled, this overrides and sets OpenSSL's | |
directory containing trusted certificates. | |
SSL_CERT_FILE <u>file</u> | |
If <b>--use-openssl-ca</b> is enabled, this overrides and sets OpenSSL's | |
file containing trusted certificates. | |
<b>BUGS</b> | |
Bugs are tracked in GitHub Issues: <b>https://github.com/nodejs/node/issues</b> | |
<b>COPYRIGHT</b> | |
Copyright Node.js contributors. Node.js is available under the MIT | |
license. | |
Node.js also includes external libraries that are available under a vari- | |
ety of licenses. See <b>https://github.com/nodejs/node/blob/master/LICENSE</b> | |
for the full license text. | |
<b>SEE ALSO</b> | |
Website: <b>https://nodejs.org/</b> | |
Documentation: <b>https://nodejs.org/api/</b> | |
GitHub repository & Issue Tracker: <b>https://github.com/nodejs/node</b> | |
Mailing list: <b>http://groups.google.com/group/nodejs</b> | |
IRC (general questions): <b>chat.freenode.net #node.js</b> (unofficial) | |
IRC (Node.js core development): <b>chat.freenode.net #node-dev</b> | |
<b>AUTHORS</b> | |
Written and maintained by 1000+ contributors: | |
<b>https://github.com/nodejs/node/blob/master/AUTHORS</b> | |
May 15, 2018 | |
</pre></body></html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
<!DOCTYPE html><html lang="en"><head><meta charset="UTF-8"/><title>Preview</title><style> html{ background: black; color: white } a{ color: inherit; text-decoration: none } pre{ font: 10px Menloco, Monaco, Menlo, monospace; font-variant-ligatures: none }</style></head><body><pre> | |
NPM-INSTALL(1) NPM-INSTALL(1) | |
<b>NAME</b> | |
<b>npm-install</b> - Install a package | |
<b>SYNOPSIS</b> | |
npm install (with no args, in package dir) | |
npm install [<@scope>/]<name> | |
npm install [<@scope>/]<name>@<tag> | |
npm install [<@scope>/]<name>@<version> | |
npm install [<@scope>/]<name>@<version range> | |
npm install <git-host>:<git-user>/<repo-name> | |
npm install <git repo url> | |
npm install <tarball file> | |
npm install <tarball url> | |
npm install <folder> | |
alias: npm i | |
common options: [-P|--save-prod|-D|--save-dev|-O|--save-optional] [-E|--save-exact] [-B|--save-bundle] [--no-save] [--dry-run] | |
<b>DESCRIPTION</b> | |
This command installs a package, and any packages that it depends on. | |
If the package has a package-lock or shrinkwrap file, the installation | |
of dependencies will be driven by that, with an <b>npm-shrinkwrap.json</b> | |
taking precedence if both files exist. See npm help 5 package-lock.json | |
and npm help shrinkwrap. | |
A <b>package</b> is: | |
· a) a folder containing a program described by a npm help 5 <b>pack-</b> | |
<b>age.json</b> file | |
· b) a gzipped tarball containing (a) | |
· c) a url that resolves to (b) | |
· d) a <b><name>@<version></b> that is published on the registry (see npm help | |
7 <b>npm-registry</b>) with (c) | |
· e) a <b><name>@<tag></b> (see npm help <b>npm-dist-tag</b>) that points to (d) | |
· f) a <b><name></b> that has a "latest" tag satisfying (e) | |
· g) a <b><git remote url></b> that resolves to (a) | |
Even if you never publish your package, you can still get a lot of ben- | |
efits of using npm if you just want to write a node program (a), and | |
perhaps if you also want to be able to easily install it elsewhere | |
after packing it up into a tarball (b). | |
· <b>npm install</b> (in package directory, no arguments): | |
Install the dependencies in the local node_modules folder. | |
In global mode (ie, with <b>-g</b> or <b>--global</b> appended to the command), | |
it installs the current package context (ie, the current working | |
directory) as a global package. | |
By default, <b>npm install</b> will install all modules listed as depen- | |
dencies | |
in npm help 5 <b>package.json</b>. | |
With the <b>--production</b> flag (or when the <b>NODE_ENV</b> environment vari- | |
able | |
is set to <b>production</b>), npm will not install modules listed in | |
<b>devDependencies</b>. | |
· <b>npm install <folder></b>: | |
Install the package in the directory as a symlink in the current | |
project. | |
Its dependencies will be installed before it's linked. If <b><folder></b> | |
sits | |
inside the root of your project, its dependencies may be hoisted to | |
the | |
toplevel <b>node_modules</b> as they would for other types of dependen- | |
cies. | |
· <b>npm install <tarball file></b>: | |
Install a package that is sitting on the filesystem. Note: if you | |
just want | |
to link a dev directory into your npm root, you can do this more | |
easily by | |
using <b>npm link</b>. The filename <u>must</u> use <b>.tar</b>, <b>.tar.gz</b>, or <b>.tgz</b> as | |
the extension. | |
Example: | |
npm install ./package.tgz | |
· <b>npm install <tarball url></b>: | |
Fetch the tarball url, and then install it. In order to distin- | |
guish between | |
this and other options, the argument must start with "http://" or | |
"https://" | |
Example: | |
npm install <a href="https://github.com/indexzero/forever/tarball/v0.5.6">https://github.com/indexzero/forever/tarball/v0.5.6</a> | |
· <b>npm install [<@scope>/]<name></b>: | |
Do a <b><name>@<tag></b> install, where <b><tag></b> is the "tag" config. (See | |
npm help 7 <b>npm-config</b>. The config's default value is <b>latest</b>.) | |
In most cases, this will install the version of the modules tagged | |
as | |
<b>latest</b> on the npm registry. | |
Example: | |
npm install sax | |
<b>npm install</b> saves any specified packages into <b>dependencies</b> by | |
default. | |
Additionally, you can control where and how they get saved with some | |
additional flags: | |
· <b>-P, --save-prod</b>: Package will appear in your <b>dependencies</b>. This is | |
the | |
default unless `-D` or `-O` are present. | |
· <b>-D, --save-dev</b>: Package will appear in your <b>devDependencies</b>. | |
· <b>-O, --save-optional</b>: Package will appear in your <b>optionalDependen-</b> | |
<b>cies</b>. | |
· <b>--no-save</b>: Prevents saving to <b>dependencies</b>. When using any of the | |
above options to save dependencies to your package.json, there are | |
two additional, optional flags: | |
· <b>-E, --save-exact</b>: Saved dependencies will be configured with an exact | |
version rather than using npm's default semver range operator. | |
· <b>-B, --save-bundle</b>: Saved dependencies will also be added to your <b>bun-</b> | |
<b>dleDependencies</b> list. Further, if you have an <b>npm-shrinkwrap.json</b> or | |
<b>package-lock.json</b> then it will be updated as well. <b><scope></b> is | |
optional. The package will be downloaded from the registry associated | |
with the specified scope. If no registry is associated with the given | |
scope the default registry is assumed. See npm help 7 <b>npm-scope</b>. | |
Note: if you do not include the @-symbol on your scope name, npm will | |
interpret this as a GitHub repository instead, see below. Scopes | |
names must also be followed by a slash. Examples: | |
npm install sax | |
npm install githubname/reponame | |
npm install @myorg/privatepackage | |
npm install node-tap --save-dev | |
npm install dtrace-provider --save-optional | |
npm install readable-stream --save-exact | |
npm install ansi-regex --save-bundle | |
**Note**: If there is a file or folder named `<name>` in the current | |
working directory, then it will try to install that, and only try to | |
fetch the package by name if it is not valid. | |
· <b>npm install [<@scope>/]<name>@<tag></b>: | |
Install the version of the package that is referenced by the speci- | |
fied tag. | |
If the tag does not exist in the registry data for that package, | |
then this | |
will fail. | |
Example: | |
npm install sax@latest | |
npm install @myorg/mypackage@latest | |
· <b>npm install [<@scope>/]<name>@<version></b>: | |
Install the specified version of the package. This will fail if | |
the | |
version has not been published to the registry. | |
Example: | |
npm install sax@0.1.1 | |
npm install @myorg/privatepackage@1.5.0 | |
· <b>npm install [<@scope>/]<name>@<version range></b>: | |
Install a version of the package matching the specified version | |
range. This | |
will follow the same rules for resolving dependencies described in | |
npm help 5 <b>package.json</b>. | |
Note that most version ranges must be put in quotes so that your | |
shell will | |
treat it as a single argument. | |
Example: | |
npm install sax@">=0.1.0 <0.2.0" | |
npm install @myorg/privatepackage@">=0.1.0 <0.2.0" | |
· <b>npm install <git remote url></b>: | |
Installs the package from the hosted git provider, cloning it with | |
<b>git</b>. | |
For a full git remote url, only that URL will be attempted. | |
<protocol>://[<user>[:<password>]@]<hostname>[:<port>][:][/]<path>[#<commit-ish> | #semver:<semver>] | |
<b><protocol></b> is one of <b>git</b>, <b>git+ssh</b>, <b>git+http</b>, <b>git+https</b>, or | |
<b>git+file</b>. | |
If <b>#<commit-ish></b> is provided, it will be used to clone exactly that | |
commit. If the commit-ish has the format <b>#semver:<semver></b>, <b><semver></b> | |
can | |
be any valid semver range or exact version, and npm will look for any | |
tags | |
or refs matching that range in the remote repository, much as it | |
would for a | |
registry dependency. If neither <b>#<commit-ish></b> or <b>#semver:<semver></b> is | |
specified, then <b>master</b> is used. | |
If the repository makes use of submodules, those submodules will be | |
cloned | |
as well. | |
If the package being installed contains a <b>prepare</b> script, its | |
<b>dependencies</b> and <b>devDependencies</b> will be installed, and the prepare | |
script will be run, before the package is packaged and installed. | |
The following git environment variables are recognized by npm and | |
will be | |
added to the environment when running git: | |
· <b>GIT_ASKPASS</b> | |
· <b>GIT_EXEC_PATH</b> | |
· <b>GIT_PROXY_COMMAND</b> | |
· <b>GIT_SSH</b> | |
· <b>GIT_SSH_COMMAND</b> | |
· <b>GIT_SSL_CAINFO</b> | |
· <b>GIT_SSL_NO_VERIFY</b> See the git man page for details. Examples: | |
npm install git+ssh://git@github.com:npm/npm.git#v1.0.27 | |
npm install git+ssh://git@github.com:npm/npm#semver:^5.0 | |
npm install git+https://isaacs@github.com/npm/npm.git | |
npm install git://github.com/npm/npm.git#v1.0.27 | |
GIT_SSH_COMMAND='ssh -i ~/.ssh/custom_ident' npm install git+ssh://git@github.com:npm/npm.git | |
· <b>npm install <githubname>/<githubrepo>[#<commit-ish>]</b>: | |
· <b>npm install github:<githubname>/<githubrepo>[#<commit-ish>]</b>: | |
Install the package at <b>https://github.com/githubname/githubrepo</b> by | |
attempting to clone it using <b>git</b>. | |
If <b>#<commit-ish></b> is provided, it will be used to clone exactly that | |
commit. If the commit-ish has the format <b>#semver:<semver></b>, <b><semver></b> | |
can | |
be any valid semver range or exact version, and npm will look for | |
any tags | |
or refs matching that range in the remote repository, much as it | |
would for a | |
registry dependency. If neither <b>#<commit-ish></b> or <b>#semver:<semver></b> | |
is | |
specified, then <b>master</b> is used. | |
As with regular git dependencies, <b>dependencies</b> and <b>devDependencies</b> | |
will | |
be installed if the package has a <b>prepare</b> script, before the pack- | |
age is | |
done installing. | |
Examples: | |
npm install mygithubuser/myproject | |
npm install github:mygithubuser/myproject | |
· <b>npm install gist:[<githubname>/]<gistID>[#<com-</b> | |
<b>mit-ish>|#semver:<semver>]</b>: | |
Install the package at <b>https://gist.github.com/gistID</b> by attempting | |
to | |
clone it using <b>git</b>. The GitHub username associated with the gist is | |
optional and will not be saved in <b>package.json</b>. | |
As with regular git dependencies, <b>dependencies</b> and <b>devDependencies</b> | |
will | |
be installed if the package has a <b>prepare</b> script, before the pack- | |
age is | |
done installing. | |
Example: | |
npm install gist:101a11beef | |
· <b>npm install bitbucket:<bitbucketname>/<bitbucketrepo>[#<commit-ish>]</b>: | |
Install the package at <b>https://bitbucket.org/bitbucketname/bitbuck-</b> | |
<b>etrepo</b> | |
by attempting to clone it using <b>git</b>. | |
If <b>#<commit-ish></b> is provided, it will be used to clone exactly that | |
commit. If the commit-ish has the format <b>#semver:<semver></b>, <b><semver></b> | |
can | |
be any valid semver range or exact version, and npm will look for | |
any tags | |
or refs matching that range in the remote repository, much as it | |
would for a | |
registry dependency. If neither <b>#<commit-ish></b> or <b>#semver:<semver></b> | |
is | |
specified, then <b>master</b> is used. | |
As with regular git dependencies, <b>dependencies</b> and <b>devDependencies</b> | |
will | |
be installed if the package has a <b>prepare</b> script, before the pack- | |
age is | |
done installing. | |
Example: | |
npm install bitbucket:mybitbucketuser/myproject | |
· <b>npm install gitlab:<gitlabname>/<gitlabrepo>[#<commit-ish>]</b>: | |
Install the package at <b>https://gitlab.com/gitlabname/gitlabrepo</b> | |
by attempting to clone it using <b>git</b>. | |
If <b>#<commit-ish></b> is provided, it will be used to clone exactly that | |
commit. If the commit-ish has the format <b>#semver:<semver></b>, <b><semver></b> | |
can | |
be any valid semver range or exact version, and npm will look for | |
any tags | |
or refs matching that range in the remote repository, much as it | |
would for a | |
registry dependency. If neither <b>#<commit-ish></b> or <b>#semver:<semver></b> | |
is | |
specified, then <b>master</b> is used. | |
As with regular git dependencies, <b>dependencies</b> and <b>devDependencies</b> | |
will | |
be installed if the package has a <b>prepare</b> script, before the pack- | |
age is | |
done installing. | |
Example: | |
npm install gitlab:mygitlabuser/myproject | |
npm install gitlab:myusr/myproj#semver:^5.0 | |
You may combine multiple arguments, and even multiple types of argu- | |
ments. For example: | |
npm install sax@">=0.1.0 <0.2.0" bench supervisor | |
The <b>--tag</b> argument will apply to all of the specified install targets. | |
If a tag with the given name exists, the tagged version is preferred | |
over newer versions. | |
The <b>--dry-run</b> argument will report in the usual way what the install | |
would have done without actually installing anything. | |
The <b>--package-lock-only</b> argument will only update the <b>pack-</b> | |
<b>age-lock.json</b>, instead of checking <b>node_modules</b> and downloading depen- | |
dencies. | |
The <b>-f</b> or <b>--force</b> argument will force npm to fetch remote resources | |
even if a local copy exists on disk. | |
npm install sax --force | |
The <b>-g</b> or <b>--global</b> argument will cause npm to install the package glob- | |
ally rather than locally. See npm help 5 <b>npm-folders</b>. | |
The <b>--global-style</b> argument will cause npm to install the package into | |
your local <b>node_modules</b> folder with the same layout it uses with the | |
global <b>node_modules</b> folder. Only your direct dependencies will show in | |
<b>node_modules</b> and everything they depend on will be flattened in their | |
<b>node_modules</b> folders. This obviously will eliminate some deduping. | |
The <b>--ignore-scripts</b> argument will cause npm to not execute any scripts | |
defined in the package.json. See npm help 7 <b>npm-scripts</b>. | |
The <b>--legacy-bundling</b> argument will cause npm to install the package | |
such that versions of npm prior to 1.4, such as the one included with | |
node 0.8, can install the package. This eliminates all automatic dedup- | |
ing. | |
The <b>--link</b> argument will cause npm to link global installs into the | |
local space in some cases. | |
The <b>--no-bin-links</b> argument will prevent npm from creating symlinks for | |
any binaries the package might contain. | |
The <b>--no-optional</b> argument will prevent optional dependencies from | |
being installed. | |
The <b>--no-shrinkwrap</b> argument, which will ignore an available package | |
lock or shrinkwrap file and use the package.json instead. | |
The <b>--no-package-lock</b> argument will prevent npm from creating a <b>pack-</b> | |
<b>age-lock.json</b> file. | |
The <b>--nodedir=/path/to/node/source</b> argument will allow npm to find the | |
node source code so that npm can compile native modules. | |
The <b>--only={prod[uction]|dev[elopment]}</b> argument will cause either only | |
<b>devDependencies</b> or only non-<b>devDependencies</b> to be installed regardless | |
of the <b>NODE_ENV</b>. | |
See npm help 7 <b>npm-config</b>. Many of the configuration params have some | |
effect on installation, since that's most of what npm does. | |
<b>ALGORITHM</b> | |
To install a package, npm uses the following algorithm: | |
load the existing node_modules tree from disk | |
clone the tree | |
fetch the package.json and assorted metadata and add it to the clone | |
walk the clone and add any missing dependencies | |
dependencies will be added as close to the top as is possible | |
without breaking any other modules | |
compare the original tree with the cloned tree and make a list of | |
actions to take to convert one to the other | |
execute all of the actions, deepest first | |
kinds of actions are install, update, remove and move | |
For this <b>package{dep}</b> structure: <b>A{B,C}, B{C}, C{D}</b>, this algorithm | |
produces: | |
A | |
+-- B | |
+-- C | |
+-- D | |
That is, the dependency from B to C is satisfied by the fact that A | |
already caused C to be installed at a higher level. D is still | |
installed at the top level because nothing conflicts with it. | |
For <b>A{B,C}, B{C,D@1}, C{D@2}</b>, this algorithm produces: | |
A | |
+-- B | |
+-- C | |
`-- D@2 | |
+-- D@1 | |
Because B's D@1 will be installed in the top level, C now has to | |
install D@2 privately for itself. This algorithm is deterministic, but | |
different trees may be produced if two dependencies are requested for | |
installation in a different order. | |
See npm help 5 folders for a more detailed description of the specific | |
folder structures that npm creates. | |
<b>Limitations of npm's Install Algorithm</b> | |
npm will refuse to install any package with an identical name to the | |
current package. This can be overridden with the <b>--force</b> flag, but in | |
most cases can simply be addressed by changing the local package name. | |
There are some very rare and pathological edge-cases where a cycle can | |
cause npm to try to install a never-ending tree of packages. Here is | |
the simplest case: | |
A -> B -> A' -> B' -> A -> B -> A' -> B' -> A -> ... | |
where <b>A</b> is some version of a package, and <b>A'</b> is a different version of | |
the same package. Because <b>B</b> depends on a different version of <b>A</b> than | |
the one that is already in the tree, it must install a separate copy. | |
The same is true of <b>A'</b>, which must install <b>B'</b>. Because <b>B'</b> depends on | |
the original version of <b>A</b>, which has been overridden, the cycle falls | |
into infinite regress. | |
To avoid this situation, npm flat-out refuses to install any <b>name@ver-</b> | |
<b>sion</b> that is already present anywhere in the tree of package folder | |
ancestors. A more correct, but more complex, solution would be to sym- | |
link the existing version into the new location. If this ever affects | |
a real use-case, it will be investigated. | |
<b>SEE ALSO</b> | |
· npm help 5 folders | |
· npm help update | |
· npm help link | |
· npm help rebuild | |
· npm help 7 scripts | |
· npm help build | |
· npm help config | |
· npm help 7 config | |
· npm help 5 npmrc | |
· npm help 7 registry | |
· npm help dist-tag | |
· npm help uninstall | |
· npm help shrinkwrap | |
· npm help 5 package.json | |
November 2017 NPM-INSTALL(1) | |
</pre></body></html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
<!DOCTYPE html><html lang="en"><head><meta charset="UTF-8"/><title>Preview</title><style> html{ background: black; color: white } a{ color: inherit; text-decoration: none } pre{ font: 10px Menloco, Monaco, Menlo, monospace; font-variant-ligatures: none }</style></head><body><pre> | |
<a href="man://pfmtopam/1">pfmtopam(1)</a> Netpbm pointer man pages <a href="man://pfmtopam/1">pfmtopam(1)</a> | |
<b>NAME</b> | |
pfmtopam − see <a href="http://netpbm.sourceforge.net/doc/pfmtopam.html">http://netpbm.sourceforge.net/doc/pfmtopam.html</a> | |
<b>DESCRIPTION</b> | |
pfmtopam is part of the Netpbm package. Netpbm documentation is kept | |
in HTML format. | |
Please refer to <<a href="http://netpbm.sourceforge.net/doc//pfmtopam.html">http://netpbm.sourceforge.net/doc//pfmtopam.html</a>>. | |
If that doesn't work, also try <<a href="http://netpbm.sourceforge.net">http://netpbm.sourceforge.net</a>> and | |
emailing Bryan Henderson, bryanh@giraffe-data.com. | |
Note that it is possible to install Netpbm with the documentation | |
available differently. For example, you could simply see the documen- | |
tation instead of the message you are reading now. The file 'doc/USER- | |
DOC' in the Netpbm source tree contains details. | |
Nov 21:59:25 Netpbm <a href="man://pfmtopam/1">pfmtopam(1)</a> | |
</pre></body></html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
<!DOCTYPE html><html lang="en"><head><meta charset="UTF-8"/><title>Preview</title><style> html{ background: black; color: white } a{ color: inherit; text-decoration: none } pre{ font: 10px Menloco, Monaco, Menlo, monospace; font-variant-ligatures: none }</style></head><body><pre> | |
VZVOL(1) BSD General Commands Manual VZVOL(1) | |
<b>NAME</b> | |
<b>vzvol</b> — ZFS zvol management utility | |
<b>SYNOPSIS</b> | |
<b>vzvol</b> [<b>-h</b>|<b>--help</b>] [<b>-s</b>|<b>--size</b> <u>size</u>] [<b>-u</b>|<b>--user</b> <u>name</u>] [<b>-v</b>|<b>--volume</b> <u>name</u>] | |
[<b>-p</b>|<b>--pool</b>] [<b>-t</b>|<b>--type</b> <u>behaviour</u>] [<b>--file-system</b> <u>name</u>] | |
[<b>--import</b> <u>source</u>] [<b>-p</b>] [<b>--format</b> <u>type</u> <u>zvol</u>] [<b>--delete</b> <u>zvol</u>] | |
[<b>--list</b>] | |
<b>DESCRIPTION</b> | |
<b>vzvol</b> is a shell-script designated to help automate the process of creat- | |
ing a ZFS zvol for use as a storage unit for virtualisation or testing. | |
<b>vzvol</b> was originally created to allow you to back a light .VMDK file with | |
a zvol for use with VirtualBox. However, additional functionality has | |
been added over time to make <b>vzvol</b> a general-use program. | |
<b>-h</b>, <b>--help</b> | |
Shows this help | |
<b>-s</b>, <b>--size</b> <u>value</u>=<u>10G</u> | |
Set the size of the zvol. Values should include a unit suffix | |
like <b>M</b> (Megabytes) or <b>G</b> (Gigabytes). Defaults to <u>10G</u> if unspeci- | |
fied. | |
<b>-u</b>, <b>--user</b> <u>name</u> | |
Set the user under which we grant permissions for the zvol. | |
<u>Important</u>: No longer defaults to your username, and is a manda- | |
tory option. | |
<b>-v</b>, <b>--volume</b> <u>name</u> | |
Name of zvol. | |
<b>-p</b>, <b>--pool</b> | |
Override the logic to choose the zpool you want your zvol on. By | |
default, this script selects the first zpool available, unless | |
your first pool is “bootpool” (this script will default to the | |
second listed pool, usually “zroot” in a default install). | |
<b>-t</b>, <b>--type</b> <u>behaviour</u> | |
Set the disk type behaviour. The following types are accepted: | |
<b>virtualbox</b> The default behaviour. <b>vzvol</b> will create a | |
shim VMDK to point to the created zvol. | |
<b>raw</b> Create a raw, normal zvol with no shim, in the | |
default location of | |
<u>/dev/zvol/poolname/volumename</u>. | |
<b>--file-system</b> <u>type</u> | |
Setting this flag allows you to format the zvol with your choice | |
of filesystem. The default for vzvol is to not create a filesys- | |
tem on the new zvol. Acceptable <u>type</u> values are listed below: | |
Filesystems with support in FreeBSD: | |
<b>zfs</b> Creates a ZFS filesystem, using the name set in | |
<b>--volume</b> as the pool name. | |
<b>ufs</b> Create a FreeBSD-compatible UFS2 filesystem | |
<b>fat32</b> Create an MS-DOS compatible FAT32 filesystem | |
Filesystems which require <u>sysutils/e2fsprogs</u>: | |
<b>ext2</b> Create a Linux-compatible ext2 filesystem. | |
<b>ext2</b> Create a Linux-compatible ext3 filesystem. | |
<b>ext2</b> Creates a Linux-compatible ext4 filesystem. | |
Filesystems which require <u>sysutils/xfsprogs</u>: | |
<b>xfs</b> Create an XFS filesystem. | |
<b>--import</b> <u>source</u> | |
Import the contents of a downloaded disk image to your newly-cre- | |
ated zvol. This is useful when using a pre-installed VM image, | |
such as <u>https://github.com/UN/FreeBSD-On-Linode</u>. | |
<b>-p</b> Used with <b>--import</b> to show a progress bar for image data importa- | |
tion to the vzol. Requires that <u>sysutils/pv</u> be installed. | |
<b>--format</b> <u>type</u> <u>zvol</u> | |
Reformat a zvol created by <b>vzvol</b>, using the same options and | |
arguments as <b>--file-system</b>. For example: “vzvol --format xfs | |
zroot/smartos” | |
<b>--delete</b> <u>zvol</u> | |
Delete the <u>zvol</u> you specify. If a .VMDK file is associated with | |
the zvol, the .VMDK will also be deleted. You MUST specify the | |
zpool the zvol resides on. You can get this information from | |
running “vzvol --list” or “zfs list -t volume”. | |
Example: | |
vzvol --delete zroot/smartos11 | |
<b>--list</b> List all zvols on your system, the type, any associated .VMDK | |
files, how much space on disk is used by the zvol, the maximum | |
size of the zvol capacity, and the filesystem, if vzvol can | |
determine it. Imported images will list FS as “imported”, and | |
any zvol that doesn't have “custom:FS” set will report “unknown”. | |
Example output: | |
ZVOL TYPE VMDK USED SIZE FS | |
zroot/smartos RAW none 20G 50G zfs | |
zroot/ubuntu1604 VirtualBox /home/username/VBoxDisks/ubuntu1604.vmdk 1.51G 10G ext4 | |
<b>SEE ALSO</b> | |
<a href="man://xfs/8">xfs(8)</a>, <a href="man://zpool/8">zpool(8)</a> | |
<b>AUTHORS</b> | |
This script is released under the 2-clause BSD license. © 2017 | |
RainbowHackerHorse <<a href="https://github.com/RainbowHackerHorse/vzvol">https://github.com/RainbowHackerHorse/vzvol</a>> | |
BSD April 19, 2018 BSD | |
</pre></body></html> |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment