From b8adb4e3fdcb0ab79f942648f1bdf2caa2843280 Mon Sep 17 00:00:00 2001 From: Ben Butler-Cole Date: Wed, 19 Oct 2016 14:13:58 +0100 Subject: [PATCH] Use static manpages rather than generating them from asciidoc --- .../neo4j/src/docs/ops/upgrades.asciidoc | 5 +- .../src/docs/man/neo4j-backup.1.asciidoc | 81 ----- manual/contents/src/manpages.asciidoc | 25 -- manual/contents/src/neo4j-manual.asciidoc | 6 - manual/contents/src/preface/preface.asciidoc | 1 - .../src/docs/man/neo4j-import.1.asciidoc | 56 ---- manual/manual/Makefile | 4 +- .../manual/assemblies/manpages-enterprise.xml | 45 --- manual/manual/assemblies/manpages.xml | 44 --- manual/manual/pom.xml | 60 ---- .../src/docs/man/neo4j-admin.1.asciidoc | 18 -- .../server-docs/src/docs/man/neo4j.1.asciidoc | 55 ---- manual/shell/src/docs/dev/shell.asciidoc | 2 - .../shell/src/docs/man/neo4j-shell.1.asciidoc | 75 ----- .../installer-debian/build.xml | 2 +- .../installer-linux/installer-debian/pom.xml | 34 -- .../resources/common/manpages/neo4j-admin.1 | 50 +++ .../resources/common/manpages/neo4j-backup.1 | 147 +++++++++ .../resources/common/manpages/neo4j-import.1 | 305 ++++++++++++++++++ .../resources/common/manpages/neo4j-shell.1 | 187 +++++++++++ .../main/resources/common/manpages/neo4j.1 | 147 +++++++++ .../resources/community/debian/neo4j.manpages | 8 +- .../debian/neo4j-enterprise.manpages | 10 +- packaging/standalone/pom.xml | 13 - .../main/assemblies/community-unix-dist.xml | 1 - .../assemblies/community-windows-dist.xml | 1 - .../main/assemblies/enterprise-unix-dist.xml | 1 - .../assemblies/enterprise-windows-dist.xml | 1 - 28 files changed, 848 insertions(+), 536 deletions(-) delete mode 100644 manual/backup/src/docs/man/neo4j-backup.1.asciidoc delete mode 100644 manual/contents/src/manpages.asciidoc delete mode 100644 manual/import-tool/src/docs/man/neo4j-import.1.asciidoc delete mode 100644 manual/manual/assemblies/manpages-enterprise.xml delete mode 100644 manual/manual/assemblies/manpages.xml delete mode 100644 manual/server-docs/src/docs/man/neo4j-admin.1.asciidoc delete mode 100644 manual/server-docs/src/docs/man/neo4j.1.asciidoc delete mode 100644 manual/shell/src/docs/man/neo4j-shell.1.asciidoc create mode 100644 packaging/installer-linux/installer-debian/src/main/resources/common/manpages/neo4j-admin.1 create mode 100644 packaging/installer-linux/installer-debian/src/main/resources/common/manpages/neo4j-backup.1 create mode 100644 packaging/installer-linux/installer-debian/src/main/resources/common/manpages/neo4j-import.1 create mode 100644 packaging/installer-linux/installer-debian/src/main/resources/common/manpages/neo4j-shell.1 create mode 100644 packaging/installer-linux/installer-debian/src/main/resources/common/manpages/neo4j.1 diff --git a/community/neo4j/src/docs/ops/upgrades.asciidoc b/community/neo4j/src/docs/ops/upgrades.asciidoc index 901800a3db8ce..1cac59465015c 100644 --- a/community/neo4j/src/docs/ops/upgrades.asciidoc +++ b/community/neo4j/src/docs/ops/upgrades.asciidoc @@ -2,7 +2,6 @@ = Upgrading :manual-ha-upgrade-guide: {operations-manual-base-uri}/#ha-upgrade-guide -:manual-neo4j-admin-manpage: {operations-manual-base-uri}/#man-neo4j-admin :neo4j-releases-download-page: http://neo4j.com/download/other-releases This section describes upgrading a _single_ Neo4j instance. @@ -52,9 +51,7 @@ available with Neo4j Enterprise, ensure that backups have completed successfully . Install Neo4j {neo4j-version}. . Review the settings in the configuration files in the previous installation, and transfer any custom settings to the {neo4j-version} installation. Since many settings have been changed between Neo4j 2.x and Neo4j 3.0, it is advisable to use the `config-migrator` to migrate the config files for you. The `config-migrator` can be found in the `tools` directory, and can be invoked with a command like: `java -jar config-migrator.jar path/to/neo4j2.3 path/to/neo4j3.0`. Take note of any warnings printed, and manually review the edited config files produced. -. Import your data from the old installation using `neo4j-admin import --mode=database --database= --from=` (for details, see -ifndef::upgradetext[<>).] -ifdef::upgradetext[the man page at {manual-neo4j-admin-manpage}).] +. Import your data from the old installation using `neo4j-admin import --mode=database --database= --from=` (for details, see `neo4j-admin help import`). . If the database is not called `graph.db`, set `dbms.active_database` in `neo4j.conf` to the name of the database. . Set `dbms.allow_format_migration=true` in `neo4j.conf` of the {neo4j-version} installation. Neo4j will fail to start without this configuration. diff --git a/manual/backup/src/docs/man/neo4j-backup.1.asciidoc b/manual/backup/src/docs/man/neo4j-backup.1.asciidoc deleted file mode 100644 index 34a7495104b63..0000000000000 --- a/manual/backup/src/docs/man/neo4j-backup.1.asciidoc +++ /dev/null @@ -1,81 +0,0 @@ -= NEO4J-BACKUP(1) -:author: The Neo4j Team - -== NAME -neo4j-backup - Neo4j Backup Tool - -[[neo4j-backup-manpage]] -== SYNOPSIS - -*neo4j-backup* -host [-port ] -to target_directory - -[[neo4j-backup-manpage-description]] -== DESCRIPTION - -A tool to perform live backups over the network from a running Neo4j graph database onto a local filesystem. -Backups can be either full or incremental. -The first backup must be a full backup, after that incremental backups can be performed. - -The source(s) are given as host:port pairs, the target is a filesystem location. - -For help regarding Windows, see the reference in https://neo4j.com/docs/operations-manual/current/deployment/single-instance/windows/. - -== BACKUP TYPE - -*-full*:: - copies the entire database to a directory. - -*-incremental*:: - copies the changes that have taken place since the last full or - incremental backup to an existing backup store. - -The backup tool will automatically detect whether it needs to do a full or an incremental backup. - -[[neo4j-backup-manpage-source-address]] -== SOURCE ADDRESS - -Backup sources are given in the following format: - -*-host [-port ]* - -*host*:: - In single mode, the host of a source database; in HA mode, the cluster address of a cluster member. - -*port*:: - In single mode, the port of a source database backup service; in HA mode, the port of a cluster instance. If not given, the default value `6362` will be used for single mode, `5001` for HA. - -[[neo4j-backup-manpage-usage-important]] -== IMPORTANT - -Backups can only be performed on databases which have the configuration parameter *`enable_online_backup=true`* set. -That will make the backup service available on the default port (`6362`). -To enable the backup service on a different port use for example *`enable_online_backup=port=9999`* instead. - -[[neo4j-backup-manpage-examples]] -== EXAMPLES - -[source,shell] ----- -# Performing a backup the first time: create a blank directory and run the backup tool -mkdir /mnt/backup/neo4j-backup -neo4j-backup -host 192.168.1.34 -to /mnt/backup/neo4j-backup - -# Subsequent backups using the same _target_-directory will be incremental and therefore quick -neo4j-backup -host freja -to /mnt/backup/neo4j-backup - -# Performing a backup where the service is registered on a custom port -neo4j-backup -host freja -port 9999 -to /mnt/backup/neo4j-backup - -# Performing a backup from HA cluster, specifying a cluster member -./neo4j-backup -host oden -to /mnt/backup/neo4j-backup - -# Performing a backup from HA cluster, specifying a cluster member registered on custom port -./neo4j-backup -host oden -port 9191 -to /mnt/backup/neo4j-backup ----- - -[[neo4j-backup-manpage-restore]] -== RESTORE FROM BACKUP - -The Neo4j backups are fully functional databases. -To use a backup, replace your database directory with the backup. - diff --git a/manual/contents/src/manpages.asciidoc b/manual/contents/src/manpages.asciidoc deleted file mode 100644 index 2328ab3c52b59..0000000000000 --- a/manual/contents/src/manpages.asciidoc +++ /dev/null @@ -1,25 +0,0 @@ -[appendix] -[[manpages]] -Manpages -======== - -The Neo4j Unix manual pages are included on the following pages. - -* <> -* <> -* <> -* <> -* <> - - -:leveloffset: 1 - -[subs="none"] -++++++++++++++++++++++++++++++++++++++ - - - - - -++++++++++++++++++++++++++++++++++++++ - diff --git a/manual/contents/src/neo4j-manual.asciidoc b/manual/contents/src/neo4j-manual.asciidoc index b29d0744bc8fb..6faa38e3da733 100644 --- a/manual/contents/src/neo4j-manual.asciidoc +++ b/manual/contents/src/neo4j-manual.asciidoc @@ -53,9 +53,3 @@ include::terminology.asciidoc[] :leveloffset: 0 include::resources.asciidoc[] - -:leveloffset: 0 - -include::manpages.asciidoc[] - - diff --git a/manual/contents/src/preface/preface.asciidoc b/manual/contents/src/preface/preface.asciidoc index a8d12428d65ee..f1bf687ca6e9c 100644 --- a/manual/contents/src/preface/preface.asciidoc +++ b/manual/contents/src/preface/preface.asciidoc @@ -15,7 +15,6 @@ The main parts of the manual are: * <> -- using Neo4j in more advanced ways. * <> -- terminology about graph databases. * <> -- find additional documentation resources. -* <> -- command line documentation. The material is practical, technical, and focused on answering specific questions. It addresses how things work, what to do and what to avoid to successfully run Neo4j in a production environment. diff --git a/manual/import-tool/src/docs/man/neo4j-import.1.asciidoc b/manual/import-tool/src/docs/man/neo4j-import.1.asciidoc deleted file mode 100644 index 3b83732ffc660..0000000000000 --- a/manual/import-tool/src/docs/man/neo4j-import.1.asciidoc +++ /dev/null @@ -1,56 +0,0 @@ -= NEO4J-IMPORT(1) -:author: The Neo4j Team - -== NAME -neo4j-import - Neo4j Import Tool - -[[neo4j-import-manpage]] -== SYNOPSIS - -*neo4j-import* [options] - -[[neo4j-import-manpage-description]] -== DESCRIPTION - -*neo4j-import* is used to create a new Neo4j database from data in CSV files. -See the chapter "Import Tool" in the Neo4j Manual for details on the CSV file format -- a special kind of header is required. - -For information regarding Windows, see https://neo4j.com/docs/operations-manual/current/deployment/single-instance/windows/. - -[[neo4j-import-manpage-options]] -== OPTIONS - -include::options.adoc[] - -[[neo4j-import-manpage-examples]] -== EXAMPLES - -Below is a basic example, where we import movies, actors and roles from three files. - -.movies.csv -[source] ----- -include::../ops/movies.csv[] ----- - -.actors.csv -[source] ----- -include::../ops/actors.csv[] ----- - -.roles.csv -[source] ----- -include::../ops/roles.csv[] ----- - -The command will look like this: - -[source] ----- -include::../ops/example-command.adoc[] ----- - -See the Neo4j Manual for further examples. - diff --git a/manual/manual/Makefile b/manual/manual/Makefile index 22280cef4e58e..a74b9f6a7df23 100644 --- a/manual/manual/Makefile +++ b/manual/manual/Makefile @@ -14,7 +14,5 @@ make_dir = $(tools_dir)/make include $(make_dir)/context-manual.make -manpage_list = "neo4j server-docs" "neo4j-admin server-docs" "neo4j-shell shell-docs" "neo4j-backup backup-docs" "neo4j-import import-tool-docs" - -webhelp_dist: initialize install-extensions manpages copy-images docbook docbook-html year-check +webhelp_dist: initialize install-extensions copy-images docbook docbook-html year-check # cleanup diff --git a/manual/manual/assemblies/manpages-enterprise.xml b/manual/manual/assemblies/manpages-enterprise.xml deleted file mode 100644 index 2c0a291cf8c5d..0000000000000 --- a/manual/manual/assemblies/manpages-enterprise.xml +++ /dev/null @@ -1,45 +0,0 @@ - - - - manpagesenterprise - false - - jar - - - - - - target/manpages - - - neo4j.* - neo4j-admin.* - neo4j-shell.* - neo4j-import.* - neo4j-backup.* - - - - - diff --git a/manual/manual/assemblies/manpages.xml b/manual/manual/assemblies/manpages.xml deleted file mode 100644 index 9e7a62866005c..0000000000000 --- a/manual/manual/assemblies/manpages.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - manpages - false - - jar - - - - - - target/manpages - - - neo4j.* - neo4j-admin.* - neo4j-shell.* - neo4j-import.* - - - - - diff --git a/manual/manual/pom.xml b/manual/manual/pom.xml index 60034d14320d5..758e24e041077 100644 --- a/manual/manual/pom.xml +++ b/manual/manual/pom.xml @@ -281,23 +281,6 @@ docbkx-maven-plugin 2.0.16 - - generate-manpages - process-classes - - generate-manpages - - - ${project.build.directory}/manpages - - - - - - - - - generate-webhelp-html process-classes @@ -328,13 +311,6 @@ section toc set toc,title - - - - - - - @@ -465,42 +441,6 @@ ${releaseVersion} - - org.apache.maven.plugins - maven-assembly-plugin - - - manpages - package - - single - - - - assemblies/manpages.xml - - ${project.artifactId}-${project.version} - true - true - - - - manpagesenterprise - package - - single - - - - assemblies/manpages-enterprise.xml - - ${project.artifactId}-${project.version} - true - true - - - - diff --git a/manual/server-docs/src/docs/man/neo4j-admin.1.asciidoc b/manual/server-docs/src/docs/man/neo4j-admin.1.asciidoc deleted file mode 100644 index c73b36057cd5f..0000000000000 --- a/manual/server-docs/src/docs/man/neo4j-admin.1.asciidoc +++ /dev/null @@ -1,18 +0,0 @@ -= NEO4J-ADMIN(1) -:author: The Neo4j Team - -== NAME -neo4j-admin - Neo4j administration - -[[neo4j-admin-manpage]] -== SYNOPSIS - -*neo4j-admin* - -[[neo4j-admin-manpage-description]] -== DESCRIPTION - -Neo4j is a graph database, perfect for working with highly connected data. -`neo4j-admin` is Neo4j's command-line administration tool. - -Please see *neo4j-admin help* for a complete list of available commands and details of how to use them. diff --git a/manual/server-docs/src/docs/man/neo4j.1.asciidoc b/manual/server-docs/src/docs/man/neo4j.1.asciidoc deleted file mode 100644 index c52263dd55b46..0000000000000 --- a/manual/server-docs/src/docs/man/neo4j.1.asciidoc +++ /dev/null @@ -1,55 +0,0 @@ -= NEO4J(1) -:author: The Neo4j Team - -== NAME -neo4j - Neo4j Server control - -[[neo4j-manpage]] -== SYNOPSIS - -*neo4j* - -[[neo4j-manpage-description]] -== DESCRIPTION - -Neo4j is a graph database, perfect for working with highly connected data. -The `neo4j` command is used to control the Neo4j Server. - -The preferred way to install Neo4j on Linux systems is by using prebuilt installation packages. - -For information regarding Windows, see https://neo4j.com/docs/operations-manual/current/deployment/single-instance/windows/. - -[[neo4j-manpage-commands]] -== COMMANDS - -*console*:: - Start the server as an application, running as a foreground process. Stop the server using `CTRL-C`. - -*start*:: - Start server as daemon, running as a background process. - -*stop*:: - Stops a running daemonized server. - -*restart*:: - Restarts the server. - -*status*:: - Current running state of the server. - -.Windows-specific commands - -*install-service*:: - Installs the server as Windows service - -*uninstall-service*:: - Uninstalls the Windows service - -[[neo4j-manpage-files]] -== FILES - -*conf/neo4j.conf*:: - Configuration. - -*conf/neo4j-wrapper.conf*:: - Configuration for service wrapper. diff --git a/manual/shell/src/docs/dev/shell.asciidoc b/manual/shell/src/docs/dev/shell.asciidoc index 0c38510f322a5..a1b73a1795421 100644 --- a/manual/shell/src/docs/dev/shell.asciidoc +++ b/manual/shell/src/docs/dev/shell.asciidoc @@ -26,8 +26,6 @@ When used together with a Neo4j server, simply issue the following at the comman bin/neo4j-shell ---- -For the full list of options, see the reference in the <>. - To connect to a running Neo4j database, use <> for local databases and see <> for remote databases. You need to make sure that the shell jar file is on the classpath when you start up your Neo4j instance. diff --git a/manual/shell/src/docs/man/neo4j-shell.1.asciidoc b/manual/shell/src/docs/man/neo4j-shell.1.asciidoc deleted file mode 100644 index 9bb4530a9e519..0000000000000 --- a/manual/shell/src/docs/man/neo4j-shell.1.asciidoc +++ /dev/null @@ -1,75 +0,0 @@ -= NEO4J-SHELL(1) -:author: The Neo4j Team - -== NAME -neo4j-shell - a command-line tool for exploring and manipulating a graph database - - -[[shell-manpage]] -== SYNOPSIS -*neo4j-shell* ['REMOTE OPTIONS'] - -*neo4j-shell* ['LOCAL OPTIONS'] - -[[shell-manpage-description]] -== DESCRIPTION -Neo4j shell is a command-line shell for running Cypher queries. -There are also commands to get information about the database. -In addition, you can browse the graph, much like how the Unix shell along with commands like +cd+, +ls+ and +pwd+ can be used to browse your local file system. -The shell can connect directly to a graph database on the file system. -To access local a local database used by other processes, use the readonly mode. - -[[shell-manpage-remote-options]] -== REMOTE OPTIONS -*-port* 'PORT':: - Port of host to connect to (default: 1337). - -*-host* 'HOST':: - Domain name or IP of host to connect to (default: localhost). - -*-name* 'NAME':: - RMI name, i.e. rmi://:/ (default: shell). - -*-readonly*:: - Access the database in read-only mode. - -[[shell-manpage-local-options]] -== LOCAL OPTIONS -*-path* 'PATH':: - The path to the database directory. - If there is no database at the location, a new one will e created. - -*-pid* 'PID':: - Process ID to connect to. - -*-readonly*:: - Access the database in read-only mode. - -*-c* 'COMMAND':: - Command line to execute. After executing it the shell exits. - -*-file* 'FILE':: - File to read and execute. After executing it the shell exits. - If '-' is supplied as filename data is read from stdin instead. - -*-config* 'CONFIG':: - The path to the Neo4j configuration file to be used. - -[[shell-manpage-examples]] -== EXAMPLES - -Examples for remote: -.... - neo4j-shell - neo4j-shell -port 1337 - neo4j-shell -host 192.168.1.234 -port 1337 -name shell - neo4j-shell -host localhost -readonly -.... - -Examples for local: -.... - neo4j-shell -path /path/to/db - neo4j-shell -path /path/to/db -config /path/to/neo4j.conf - neo4j-shell -path /path/to/db -readonly -.... - diff --git a/packaging/installer-linux/installer-debian/build.xml b/packaging/installer-linux/installer-debian/build.xml index d1e91f5f8a862..81a1845f93805 100644 --- a/packaging/installer-linux/installer-debian/build.xml +++ b/packaging/installer-linux/installer-debian/build.xml @@ -87,7 +87,7 @@ dbms.directories.certificates=/var/lib/neo4j/certificates - + diff --git a/packaging/installer-linux/installer-debian/pom.xml b/packaging/installer-linux/installer-debian/pom.xml index 30b06a38155ed..aa6d27f0461a6 100644 --- a/packaging/installer-linux/installer-debian/pom.xml +++ b/packaging/installer-linux/installer-debian/pom.xml @@ -36,21 +36,6 @@ none - - - org.neo4j.doc - neo4j-manual - ${neo4j.version} - manpages - - - org.neo4j.doc - neo4j-manual - ${neo4j.version} - manpagesenterprise - - - @@ -80,25 +65,6 @@ get-javadoc-sources none - - unpack-manpages-enterprise - generate-resources - unpack - - - - org.neo4j.doc - neo4j-manual - ${neo4j.version} - manpagesenterprise - jar - ${project.build.directory}/manpages - *.gz - META-INF/** - - - - diff --git a/packaging/installer-linux/installer-debian/src/main/resources/common/manpages/neo4j-admin.1 b/packaging/installer-linux/installer-debian/src/main/resources/common/manpages/neo4j-admin.1 new file mode 100644 index 0000000000000..8274383b74bce --- /dev/null +++ b/packaging/installer-linux/installer-debian/src/main/resources/common/manpages/neo4j-admin.1 @@ -0,0 +1,50 @@ +'\" t +.\" Title: neo4j-admin +.\" Author: The Neo4j Team +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 10/19/2016 +.\" Manual: \ \& +.\" Source: \ \& +.\" Language: English +.\" +.TH "NEO4J\-ADMIN" "1" "10/19/2016" "\ \&" "\ \&" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + + +.SH "NAME" +neo4j-admin \- Neo4j administration +.SH "SYNOPSIS" +.sp +\fBneo4j\-admin\fR + +.SH "DESCRIPTION" + +.sp +Neo4j is a graph database, perfect for working with highly connected data\&. neo4j\-admin is Neo4j\(cqs command\-line administration tool\&. +.sp +Please see neo4j\-admin help for a complete list of available commands and details of how to use them\&. + +.SH "AUTHOR" +.PP +\fBThe Neo4j Team\fR +.RS 4 +Author. +.RE diff --git a/packaging/installer-linux/installer-debian/src/main/resources/common/manpages/neo4j-backup.1 b/packaging/installer-linux/installer-debian/src/main/resources/common/manpages/neo4j-backup.1 new file mode 100644 index 0000000000000..a8b48d1882768 --- /dev/null +++ b/packaging/installer-linux/installer-debian/src/main/resources/common/manpages/neo4j-backup.1 @@ -0,0 +1,147 @@ +'\" t +.\" Title: neo4j-backup +.\" Author: The Neo4j Team +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 10/19/2016 +.\" Manual: \ \& +.\" Source: \ \& +.\" Language: English +.\" +.TH "NEO4J\-BACKUP" "1" "10/19/2016" "\ \&" "\ \&" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + + +.SH "NAME" +neo4j-backup \- Neo4j Backup Tool +.SH "SYNOPSIS" +.sp +\fBneo4j\-backup\fR \-host [\-port ] \-to target_directory + +.SH "DESCRIPTION" + +.sp +A tool to perform live backups over the network from a running Neo4j graph database onto a local filesystem\&. Backups can be either full or incremental\&. The first backup must be a full backup, after that incremental backups can be performed\&. +.sp +The source(s) are given as host:port pairs, the target is a filesystem location\&. +.sp +For help regarding Windows, see the reference in \m[blue]\fBhttps://neo4j\&.com/docs/operations\-manual/current/deployment/single\-instance/windows/\fR\m[]\&. + +.SH "BACKUP TYPE" + + + +.PP +\fB\-full\fR +.RS 4 + + + +copies the entire database to a directory\&. + +.RE +.PP +\fB\-incremental\fR +.RS 4 + + + +copies the changes that have taken place since the last full or incremental backup to an existing backup store\&. + +.RE +.sp +The backup tool will automatically detect whether it needs to do a full or an incremental backup\&. + +.SH "SOURCE ADDRESS" + +.sp +Backup sources are given in the following format: +.sp +\fB\-host [\-port ]\fR + + +.PP +\fBhost\fR +.RS 4 + + + +In single mode, the host of a source database; in HA mode, the cluster address of a cluster member\&. + +.RE +.PP +\fBport\fR +.RS 4 + + + +In single mode, the port of a source database backup service; in HA mode, the port of a cluster instance\&. If not given, the default value +6362 +will be used for single mode, +5001 +for HA\&. + +.RE + +.SH "IMPORTANT" + +.sp +Backups can only be performed on databases which have the configuration parameter \fBenable_online_backup=true\fR set\&. That will make the backup service available on the default port (6362)\&. To enable the backup service on a different port use for example \fBenable_online_backup=port=9999\fR instead\&. + +.SH "EXAMPLES" + + +.sp +.if n \{\ +.RS 4 +.\} +.nf +# Performing a backup the first time: create a blank directory and run the backup tool +mkdir /mnt/backup/neo4j\-backup +neo4j\-backup \-host 192\&.168\&.1\&.34 \-to /mnt/backup/neo4j\-backup + +# Subsequent backups using the same _target_\-directory will be incremental and therefore quick +neo4j\-backup \-host freja \-to /mnt/backup/neo4j\-backup + +# Performing a backup where the service is registered on a custom port +neo4j\-backup \-host freja \-port 9999 \-to /mnt/backup/neo4j\-backup + +# Performing a backup from HA cluster, specifying a cluster member +\&./neo4j\-backup \-host oden \-to /mnt/backup/neo4j\-backup + +# Performing a backup from HA cluster, specifying a cluster member registered on custom port +\&./neo4j\-backup \-host oden \-port 9191 \-to /mnt/backup/neo4j\-backup +.fi +.if n \{\ +.RE +.\} +.sp + +.SH "RESTORE FROM BACKUP" + +.sp +The Neo4j backups are fully functional databases\&. To use a backup, replace your database directory with the backup\&. + +.SH "AUTHOR" +.PP +\fBThe Neo4j Team\fR +.RS 4 +Author. +.RE diff --git a/packaging/installer-linux/installer-debian/src/main/resources/common/manpages/neo4j-import.1 b/packaging/installer-linux/installer-debian/src/main/resources/common/manpages/neo4j-import.1 new file mode 100644 index 0000000000000..92671706e7132 --- /dev/null +++ b/packaging/installer-linux/installer-debian/src/main/resources/common/manpages/neo4j-import.1 @@ -0,0 +1,305 @@ +'\" t +.\" Title: neo4j-import +.\" Author: The Neo4j Team +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 10/19/2016 +.\" Manual: \ \& +.\" Source: \ \& +.\" Language: English +.\" +.TH "NEO4J\-IMPORT" "1" "10/19/2016" "\ \&" "\ \&" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + + +.SH "NAME" +neo4j-import \- Neo4j Import Tool +.SH "SYNOPSIS" +.sp +\fBneo4j\-import\fR [options] + +.SH "DESCRIPTION" + +.sp +\fBneo4j\-import\fR is used to create a new Neo4j database from data in CSV files\&. See the chapter "Import Tool" in the Neo4j Manual for details on the CSV file format \(em a special kind of header is required\&. +.sp +For information regarding Windows, see \m[blue]\fBhttps://neo4j\&.com/docs/operations\-manual/current/deployment/single\-instance/windows/\fR\m[]\&. + +.SH "OPTIONS" + + + +.PP +\fB\-\-into \fR +.RS 4 + + + +Database directory to import into\&. Must not contain existing database\&. + +.RE +.PP +\fB\-\-nodes[:Label1:Label2] ",,\&..."\fR +.RS 4 + + + +Node CSV header and data\&. Multiple files will be logically seen as one big file from the perspective of the importer\&. The first line must contain the header\&. Multiple data sources like these can be specified in one import, where each data source has its own header\&. Note that file groups must be enclosed in quotation marks\&. + +.RE +.PP +\fB\-\-relationships[:RELATIONSHIP_TYPE] ",,\&..."\fR +.RS 4 + + + +Relationship CSV header and data\&. Multiple files will be logically seen as one big file from the perspective of the importer\&. The first line must contain the header\&. Multiple data sources like these can be specified in one import, where each data source has its own header\&. Note that file groups must be enclosed in quotation marks\&. + +.RE +.PP +\fB\-\-delimiter \fR +.RS 4 + + + +Delimiter character, or +\fITAB\fR, between values in CSV data\&. The default option is +,\&. + +.RE +.PP +\fB\-\-array\-delimiter \fR +.RS 4 + + + +Delimiter character, or +\fITAB\fR, between array elements within a value in CSV data\&. The default option is +;\&. + +.RE +.PP +\fB\-\-quote \fR +.RS 4 + + + +Character to treat as quotation character for values in CSV data\&. The default option is +"\&. Quotes inside quotes escaped like +"""Go away"", he said\&." +and +"\e"Go away\e", he said\&." +are supported\&. If you have set "\*(Aq" to be used as the quotation character, you could write the previous example like this instead: +\*(Aq"Go away", he said\&.\*(Aq + +.RE +.PP +\fB\-\-multiline\-fields \fR +.RS 4 + + + +Whether or not fields from input source can span multiple lines, i\&.e\&. contain newline characters\&. Default value: false + +.RE +.PP +\fB\-\-input\-encoding \fR +.RS 4 + + + +Character set that input data is encoded in\&. Provided value must be one out of the available character sets in the JVM, as provided by Charset#availableCharsets()\&. If no input encoding is provided, the default character set of the JVM will be used\&. + +.RE +.PP +\fB\-\-ignore\-empty\-strings \fR +.RS 4 + + + +Whether or not empty string fields, i\&.e\&. "" from input source are ignored, i\&.e\&. treated as null\&. Default value: false + +.RE +.PP +\fB\-\-id\-type \fR +.RS 4 + + + +One out of [STRING, INTEGER, ACTUAL] and specifies how ids in node/relationship input files are treated\&. STRING: arbitrary strings for identifying nodes\&. INTEGER: arbitrary integer values for identifying nodes\&. ACTUAL: (advanced) actual node ids\&. The default option is +STRING\&. Default value: STRING + +.RE +.PP +\fB\-\-processors \fR +.RS 4 + + + +(advanced) Max number of processors used by the importer\&. Defaults to the number of available processors reported by the JVM\&. There is a certain amount of minimum threads needed so for that reason there is no lower bound for this value\&. For optimal performance this value shouldn\(cqt be greater than the number of available processors\&. + +.RE +.PP +\fB\-\-stacktrace \fR +.RS 4 + + + +Enable printing of error stack traces\&. + +.RE +.PP +\fB\-\-bad\-tolerance \fR +.RS 4 + + + +Number of bad entries before the import is considered failed\&. This tolerance threshold is about relationships refering to missing nodes\&. Format errors in input data are still treated as errors\&. Default value: 1000 + +.RE +.PP +\fB\-\-skip\-bad\-relationships \fR +.RS 4 + + + +Whether or not to skip importing relationships that refers to missing node ids, i\&.e\&. either start or end node id/group referring to node that wasn\(cqt specified by the node input data\&. Skipped nodes will be logged, containing at most number of entites specified by bad\-tolerance\&. Default value: true + +.RE +.PP +\fB\-\-skip\-duplicate\-nodes \fR +.RS 4 + + + +Whether or not to skip importing nodes that have the same id/group\&. In the event of multiple nodes within the same group having the same id, the first encountered will be imported whereas consecutive such nodes will be skipped\&. Skipped nodes will be logged, containing at most number of entities specified by bad\-tolerance\&. Default value: false + +.RE +.PP +\fB\-\-ignore\-extra\-columns \fR +.RS 4 + + + +Whether or not to ignore extra columns in the data not specified by the header\&. Skipped columns will be logged, containing at most number of entities specified by bad\-tolerance\&. Default value: false + +.RE +.PP +\fB\-\-db\-config \fR +.RS 4 + + + +(advanced) File specifying database\-specific configuration\&. For more information consult manual about available configuration options for a neo4j configuration file\&. Only configuration affecting store at time of creation will be read\&. Examples of supported config are: dbms\&.relationship_grouping_threshold unsupported\&.dbms\&.block_size\&.strings unsupported\&.dbms\&.block_size\&.array_properties + +.RE +.PP +\fB\-\-page\-size +.\" Date: 10/19/2016 +.\" Manual: \ \& +.\" Source: \ \& +.\" Language: English +.\" +.TH "NEO4J\-SHELL" "1" "10/19/2016" "\ \&" "\ \&" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + + +.SH "NAME" +neo4j-shell \- a command\-line tool for exploring and manipulating a graph database +.SH "SYNOPSIS" +.sp +\fBneo4j\-shell\fR [\fIREMOTE OPTIONS\fR] +.sp +\fBneo4j\-shell\fR [\fILOCAL OPTIONS\fR] + +.SH "DESCRIPTION" + +.sp +Neo4j shell is a command\-line shell for running Cypher queries\&. There are also commands to get information about the database\&. In addition, you can browse the graph, much like how the Unix shell along with commands like cd, ls and pwd can be used to browse your local file system\&. The shell can connect directly to a graph database on the file system\&. To access local a local database used by other processes, use the readonly mode\&. + +.SH "REMOTE OPTIONS" + + + +.PP +\fB\-port\fR \fIPORT\fR +.RS 4 + + + +Port of host to connect to (default: 1337)\&. + +.RE +.PP +\fB\-host\fR \fIHOST\fR +.RS 4 + + + +Domain name or IP of host to connect to (default: localhost)\&. + +.RE +.PP +\fB\-name\fR \fINAME\fR +.RS 4 + + + +RMI name, i\&.e\&. rmi://:/ (default: shell)\&. + +.RE +.PP +\fB\-readonly\fR +.RS 4 + + + +Access the database in read\-only mode\&. + +.RE + +.SH "LOCAL OPTIONS" + + + +.PP +\fB\-path\fR \fIPATH\fR +.RS 4 + + + +The path to the database directory\&. If there is no database at the location, a new one will e created\&. + +.RE +.PP +\fB\-pid\fR \fIPID\fR +.RS 4 + + + +Process ID to connect to\&. + +.RE +.PP +\fB\-readonly\fR +.RS 4 + + + +Access the database in read\-only mode\&. + +.RE +.PP +\fB\-c\fR \fICOMMAND\fR +.RS 4 + + + +Command line to execute\&. After executing it the shell exits\&. + +.RE +.PP +\fB\-file\fR \fIFILE\fR +.RS 4 + + + +File to read and execute\&. After executing it the shell exits\&. If +\fI\-\fR +is supplied as filename data is read from stdin instead\&. + +.RE +.PP +\fB\-config\fR \fICONFIG\fR +.RS 4 + + + +The path to the Neo4j configuration file to be used\&. + +.RE + +.SH "EXAMPLES" + +.sp +Examples for remote: + +.sp +.if n \{\ +.RS 4 +.\} +.nf + neo4j\-shell + neo4j\-shell \-port 1337 + neo4j\-shell \-host 192\&.168\&.1\&.234 \-port 1337 \-name shell + neo4j\-shell \-host localhost \-readonly +.fi +.if n \{\ +.RE +.\} +.sp +Examples for local: + +.sp +.if n \{\ +.RS 4 +.\} +.nf + neo4j\-shell \-path /path/to/db + neo4j\-shell \-path /path/to/db \-config /path/to/neo4j\&.conf + neo4j\-shell \-path /path/to/db \-readonly +.fi +.if n \{\ +.RE +.\} +.sp + +.SH "AUTHOR" +.PP +\fBThe Neo4j Team\fR +.RS 4 +Author. +.RE diff --git a/packaging/installer-linux/installer-debian/src/main/resources/common/manpages/neo4j.1 b/packaging/installer-linux/installer-debian/src/main/resources/common/manpages/neo4j.1 new file mode 100644 index 0000000000000..a8182d7eba9cf --- /dev/null +++ b/packaging/installer-linux/installer-debian/src/main/resources/common/manpages/neo4j.1 @@ -0,0 +1,147 @@ +'\" t +.\" Title: neo4j +.\" Author: The Neo4j Team +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 10/19/2016 +.\" Manual: \ \& +.\" Source: \ \& +.\" Language: English +.\" +.TH "NEO4J" "1" "10/19/2016" "\ \&" "\ \&" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + + +.SH "NAME" +neo4j \- Neo4j Server control +.SH "SYNOPSIS" +.sp +\fBneo4j\fR + +.SH "DESCRIPTION" + +.sp +Neo4j is a graph database, perfect for working with highly connected data\&. The neo4j command is used to control the Neo4j Server\&. +.sp +The preferred way to install Neo4j on Linux systems is by using prebuilt installation packages\&. +.sp +For information regarding Windows, see \m[blue]\fBhttps://neo4j\&.com/docs/operations\-manual/current/deployment/single\-instance/windows/\fR\m[]\&. + +.SH "COMMANDS" + + + +.PP +\fBconsole\fR +.RS 4 + + + +Start the server as an application, running as a foreground process\&. Stop the server using +CTRL\-C\&. + +.RE +.PP +\fBstart\fR +.RS 4 + + + +Start server as daemon, running as a background process\&. + +.RE +.PP +\fBstop\fR +.RS 4 + + + +Stops a running daemonized server\&. + +.RE +.PP +\fBrestart\fR +.RS 4 + + + +Restarts the server\&. + +.RE +.PP +\fBstatus\fR +.RS 4 + + + +Current running state of the server\&. + +.RE + +.PP +\fBWindows\-specific commands\fR +.PP +\fBinstall\-service\fR +.RS 4 + + + +Installs the server as Windows service + +.RE +.PP +\fBuninstall\-service\fR +.RS 4 + + + +Uninstalls the Windows service + +.RE + +.SH "FILES" + + + +.PP +\fBconf/neo4j\&.conf\fR +.RS 4 + + + +Configuration\&. + +.RE +.PP +\fBconf/neo4j\-wrapper\&.conf\fR +.RS 4 + + + +Configuration for service wrapper\&. + +.RE + +.SH "AUTHOR" +.PP +\fBThe Neo4j Team\fR +.RS 4 +Author. +.RE diff --git a/packaging/installer-linux/installer-debian/src/main/resources/community/debian/neo4j.manpages b/packaging/installer-linux/installer-debian/src/main/resources/community/debian/neo4j.manpages index 203a355fbbaa0..46cecc666bf56 100644 --- a/packaging/installer-linux/installer-debian/src/main/resources/community/debian/neo4j.manpages +++ b/packaging/installer-linux/installer-debian/src/main/resources/community/debian/neo4j.manpages @@ -1,4 +1,4 @@ -manpages/neo4j.1.gz -manpages/neo4j-admin.1.gz -manpages/neo4j-shell.1.gz -manpages/neo4j-import.1.gz +manpages/neo4j.1 +manpages/neo4j-admin.1 +manpages/neo4j-shell.1 +manpages/neo4j-import.1 diff --git a/packaging/installer-linux/installer-debian/src/main/resources/enterprise/debian/neo4j-enterprise.manpages b/packaging/installer-linux/installer-debian/src/main/resources/enterprise/debian/neo4j-enterprise.manpages index 8a3dd4cafe0a0..74f7fd4d56e2a 100644 --- a/packaging/installer-linux/installer-debian/src/main/resources/enterprise/debian/neo4j-enterprise.manpages +++ b/packaging/installer-linux/installer-debian/src/main/resources/enterprise/debian/neo4j-enterprise.manpages @@ -1,5 +1,5 @@ -manpages/neo4j.1.gz -manpages/neo4j-admin.1.gz -manpages/neo4j-shell.1.gz -manpages/neo4j-import.1.gz -manpages/neo4j-backup.1.gz +manpages/neo4j.1 +manpages/neo4j-admin.1 +manpages/neo4j-shell.1 +manpages/neo4j-import.1 +manpages/neo4j-backup.1 diff --git a/packaging/standalone/pom.xml b/packaging/standalone/pom.xml index 18a256a622d4a..3dff8872a4285 100644 --- a/packaging/standalone/pom.xml +++ b/packaging/standalone/pom.xml @@ -286,19 +286,6 @@ neo4j-import-tool ${neo4j.version} - - - org.neo4j.doc - neo4j-manual - ${neo4j.version} - manpages - - - org.neo4j.doc - neo4j-manual - ${neo4j.version} - manpagesenterprise - diff --git a/packaging/standalone/standalone-community/src/main/assemblies/community-unix-dist.xml b/packaging/standalone/standalone-community/src/main/assemblies/community-unix-dist.xml index 1e3a576ad5cb0..91ee56bbda44f 100644 --- a/packaging/standalone/standalone-community/src/main/assemblies/community-unix-dist.xml +++ b/packaging/standalone/standalone-community/src/main/assemblies/community-unix-dist.xml @@ -111,7 +111,6 @@ true org.neo4j:* - org.neo4j.doc:* jline:jline org.apache.lucene:* org.scala-lang:* diff --git a/packaging/standalone/standalone-community/src/main/assemblies/community-windows-dist.xml b/packaging/standalone/standalone-community/src/main/assemblies/community-windows-dist.xml index 216a720cea347..763f0ad1fd5aa 100644 --- a/packaging/standalone/standalone-community/src/main/assemblies/community-windows-dist.xml +++ b/packaging/standalone/standalone-community/src/main/assemblies/community-windows-dist.xml @@ -103,7 +103,6 @@ true org.neo4j:* - org.neo4j.doc:* jline:jline org.apache.lucene:* org.scala-lang:* diff --git a/packaging/standalone/standalone-enterprise/src/main/assemblies/enterprise-unix-dist.xml b/packaging/standalone/standalone-enterprise/src/main/assemblies/enterprise-unix-dist.xml index a001428a24670..925b842680019 100644 --- a/packaging/standalone/standalone-enterprise/src/main/assemblies/enterprise-unix-dist.xml +++ b/packaging/standalone/standalone-enterprise/src/main/assemblies/enterprise-unix-dist.xml @@ -126,7 +126,6 @@ true org.neo4j:* - org.neo4j.doc:* jline:jline org.apache.lucene:* io.netty:netty diff --git a/packaging/standalone/standalone-enterprise/src/main/assemblies/enterprise-windows-dist.xml b/packaging/standalone/standalone-enterprise/src/main/assemblies/enterprise-windows-dist.xml index 40da5bd9b94a3..153ec31f3282e 100644 --- a/packaging/standalone/standalone-enterprise/src/main/assemblies/enterprise-windows-dist.xml +++ b/packaging/standalone/standalone-enterprise/src/main/assemblies/enterprise-windows-dist.xml @@ -104,7 +104,6 @@ true org.neo4j:* - org.neo4j.doc:* jline:jline org.apache.lucene:* io.netty:netty