[Python-modules-commits] [python-qtconsole] 01/01: add the jupyter-qtconsole.1 manpage

[Frédéric-Emmanuel Picca]

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

picca pushed a commit to branch master
in repository python-qtconsole.

commit 48469576745108764a82adf693f146168647b6ed
Author: Picca Frédéric-Emmanuel <picca at debian.org>
Date:   Wed Jun 29 17:01:25 2016 +0200

    add the jupyter-qtconsole.1 manpage
---
 debian/jupyter-qtconsole.1 | 207 +++++++++++++++++++++++++++++++++++++++++++++
 debian/rules               |   3 +
 2 files changed, 210 insertions(+)

diff --git a/debian/jupyter-qtconsole.1 b/debian/jupyter-qtconsole.1
new file mode 100644
index 0000000..3c089ef
--- /dev/null
+++ b/debian/jupyter-qtconsole.1
@@ -0,0 +1,207 @@
+.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.4.
+.TH JUPYTER-QTCONSOLE "1" "June 2016" "jupyter-qtconsole 4.2.1" "User Commands"
+.SH NAME
+jupyter-qtconsole \- manual page for jupyter-qtconsole 4.2.1
+.SH DESCRIPTION
+The Jupyter QtConsole.
+.PP
+This launches a Console\-style application using Qt.  It is not a full console,
+in that launched terminal subprocesses will not be able to accept input.
+.PP
+Options
+\fB\-\-\-\-\-\-\-\fR
+.PP
+Arguments that take values are actually convenience aliases to full
+Configurables, whose aliases are listed on the help line. For more information
+on full configurables, see '\-\-help\-all'.
+.PP
+\fB\-\-generate\-config\fR
+.IP
+generate default config file
+.PP
+\fB\-\-debug\fR
+.IP
+set log level to logging.DEBUG (maximize logging output)
+.PP
+\fB\-\-confirm\-exit\fR
+.IP
+Set to display confirmation dialog on exit. You can always use 'exit' or
+\&'quit', to force a direct exit without any confirmation. This can also
+be set in the config file by setting
+`c.JupyterConsoleApp.confirm_exit`.
+.PP
+\fB\-\-plain\fR
+.IP
+Disable rich text support.
+.PP
+\fB\-y\fR
+.IP
+Answer yes to any questions instead of prompting.
+.PP
+\fB\-\-banner\fR
+.IP
+Display a banner upon starting the QtConsole.
+.PP
+\fB\-\-no\-banner\fR
+.IP
+Don't display a banner upon starting the QtConsole.
+.PP
+\fB\-\-existing\fR
+.IP
+Connect to an existing kernel. If no argument specified, guess most recent
+.PP
+\fB\-\-no\-confirm\-exit\fR
+.IP
+Don't prompt the user when exiting. This will terminate the kernel
+if it is owned by the frontend, and leave it alive if it is external.
+This can also be set in the config file by setting
+`c.JupyterConsoleApp.confirm_exit`.
+.PP
+\fB\-\-style=\fR<Unicode> (JupyterWidget.syntax_style)
+.IP
+Default: ''
+If not empty, use this Pygments style for syntax highlighting. Otherwise,
+the style sheet is queried for Pygments style information.
+.PP
+\fB\-\-shell=\fR<Int> (JupyterConsoleApp.shell_port)
+.IP
+Default: 0
+set the shell (ROUTER) port [default: random]
+.PP
+\fB\-\-log\-level=\fR<Enum> (Application.log_level)
+.IP
+Default: 30
+Choices: (0, 10, 20, 30, 40, 50, 'DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL')
+Set the log level by value or name.
+.PP
+\fB\-\-kernel=\fR<Unicode> (JupyterConsoleApp.kernel_name)
+.IP
+Default: 'python'
+The name of the default kernel to start.
+.PP
+\fB\-\-iopub=\fR<Int> (JupyterConsoleApp.iopub_port)
+.IP
+Default: 0
+set the iopub (PUB) port [default: random]
+.PP
+\fB\-\-gui\-completion=\fR<Enum> (ConsoleWidget.gui_completion)
+.IP
+Default: 'ncurses'
+Choices: ['plain', 'droplist', 'ncurses']
+The type of completer to use. Valid values are:
+\&'plain'   : Show the available completion as a text list
+.IP
+Below the editing area.
+.IP
+\&'droplist': Show the completion in a drop down list navigable
+.IP
+by the arrow keys, and from which you can select
+completion by pressing Return.
+.IP
+\&'ncurses' : Show the completion as a text list which is navigable by
+.IP
+`tab` and arrow keys.
+.PP
+\fB\-\-config=\fR<Unicode> (JupyterApp.config_file)
+.IP
+Default: ''
+Full path of a config file.
+.PP
+\fB\-f\fR <Unicode> (JupyterConsoleApp.connection_file)
+.IP
+Default: ''
+JSON file in which to store connection info [default: kernel\-<pid>.json]
+This file will contain the IP, ports, and authentication key needed to
+connect clients to this kernel. By default, this file will be created in the
+security dir of the current profile, but can be specified by absolute path.
+.PP
+\fB\-\-stylesheet=\fR<Unicode> (JupyterQtConsoleApp.stylesheet)
+.IP
+Default: ''
+path to a custom CSS stylesheet
+.PP
+\fB\-\-hb=\fR<Int> (JupyterConsoleApp.hb_port)
+.IP
+Default: 0
+set the heartbeat port [default: random]
+.PP
+\fB\-\-ssh=\fR<Unicode> (JupyterConsoleApp.sshserver)
+.IP
+Default: ''
+The SSH server to use to connect to the kernel.
+.PP
+\fB\-\-editor=\fR<Unicode> (JupyterWidget.editor)
+.IP
+Default: ''
+A command for invoking a system text editor. If the string contains a
+{filename} format specifier, it will be used. Otherwise, the filename will
+be appended to the end the command.
+.PP
+\fB\-\-stdin=\fR<Int> (JupyterConsoleApp.stdin_port)
+.IP
+Default: 0
+set the stdin (ROUTER) port [default: random]
+.PP
+\fB\-\-ip=\fR<Unicode> (JupyterConsoleApp.ip)
+.IP
+Default: ''
+Set the kernel's IP address [default localhost]. If the IP address is
+something other than localhost, then Consoles on other machines will be able
+to connect to the Kernel, so be careful!
+.PP
+\fB\-\-transport=\fR<CaselessStrEnum> (JupyterConsoleApp.transport)
+.IP
+Default: 'tcp'
+Choices: ['tcp', 'ipc']
+.PP
+\fB\-\-existing=\fR<CUnicode> (JupyterConsoleApp.existing)
+.IP
+Default: ''
+Connect to an already running kernel
+.PP
+\fB\-\-paging=\fR<Enum> (ConsoleWidget.paging)
+.IP
+Default: 'inside'
+Choices: ['inside', 'hsplit', 'vsplit', 'custom', 'none']
+The type of paging to use. Valid values are:
+\&'inside'
+.IP
+The widget pages like a traditional terminal.
+.IP
+\&'hsplit'
+.IP
+When paging is requested, the widget is split horizontally. The top
+pane contains the console, and the bottom pane contains the paged text.
+.IP
+\&'vsplit'
+.IP
+Similar to 'hsplit', except that a vertical splitter is used.
+.IP
+\&'custom'
+.IP
+No action is taken by the widget beyond emitting a
+\&'custom_page_requested(str)' signal.
+.IP
+\&'none'
+.IP
+The text is written directly to the console.
+.PP
+To see all available configurables, use `\-\-help\-all`
+.PP
+Examples
+\fB\-\-\-\-\-\-\-\-\fR
+.TP
+jupyter qtconsole
+# start the qtconsole
+.SH "SEE ALSO"
+The full documentation for
+.B jupyter-qtconsole
+is maintained as a Texinfo manual.  If the
+.B info
+and
+.B jupyter-qtconsole
+programs are properly installed at your site, the command
+.IP
+.B info jupyter-qtconsole
+.PP
+should give you access to the complete manual.
diff --git a/debian/rules b/debian/rules
index 6585b1e..b401245 100755
--- a/debian/rules
+++ b/debian/rules
@@ -24,6 +24,9 @@ override_dh_install:
                    examples/jupyter-qtconsole.desktop \
 		   usr/share/applications
 
+override_dh_installman:
+	dh_installman -p jupyter-qtconsole debian/jupyter-qtconsole.1
+
 override_dh_sphinxdoc:
 ifeq (,$(findstring nodocs, $(DEB_BUILD_OPTIONS)))
 	cd docs && PYTHONPATH=$(CURDIR) $(MAKE) html

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/python-modules/packages/python-qtconsole.git