From 1e3f232ec050a0ddb32af05c9037ea3e7e655714 Mon Sep 17 00:00:00 2001 From: Debian Astronomy Team Date: Sat, 21 Oct 2017 14:55:11 +0100 Subject: [PATCH] man-page Gbp-Pq: Name man-page.patch --- doc/iyt.1 | 45 ++++++++++++++++++++++ doc/yt.1 | 99 ++++++++++++++++++++++++++++++++++++++++++++++++ doc/yt_lodgeit.1 | 52 +++++++++++++++++++++++++ 3 files changed, 196 insertions(+) create mode 100644 doc/iyt.1 create mode 100644 doc/yt.1 create mode 100644 doc/yt_lodgeit.1 diff --git a/doc/iyt.1 b/doc/iyt.1 new file mode 100644 index 0000000..56b7311 --- /dev/null +++ b/doc/iyt.1 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.3. +.TH IYT "1" "April 2016" "iyt 3.2.3-1" "User Commands" +.SH NAME +iyt \- iyt - Tools for Interactive Computing with yt and Python +.SH DESCRIPTION +usage: iyt [\-h] [\-\-config CONFIG] [\-\-paste] [\-\-paste\-detailed] [\-\-detailed] +.IP +[\-\-rpdb] [\-\-parallel] +.PP +yt command line arguments +.SS "optional arguments:" +.TP +\fB\-h\fR, \fB\-\-help\fR +show this help message and exit +.TP +\fB\-\-config\fR CONFIG +Set configuration option, in the form param=value +.TP +\fB\-\-paste\fR +Paste traceback to paste.yt\-project.org +.TP +\fB\-\-paste\-detailed\fR +Paste a detailed traceback with local variables to paste +\&.yt\-project.org +.TP +\fB\-\-detailed\fR +Display detailed traceback. +.TP +\fB\-\-rpdb\fR +Enable remote pdb interaction (for parallel debugging). +.TP +\fB\-\-parallel\fR +Run in MPI\-parallel mode (must be launched as an MPI task) +.SH "SEE ALSO" +The full documentation for +.B iyt +is maintained as a Texinfo manual. If the +.B info +and +.B iyt +programs are properly installed at your site, the command +.IP +.B info iyt +.PP +should give you access to the complete manual. diff --git a/doc/yt.1 b/doc/yt.1 new file mode 100644 index 0000000..ad0c221 --- /dev/null +++ b/doc/yt.1 @@ -0,0 +1,99 @@ +.TH YT "1" "August 2015" "yt 3.2.3-1" "User Commands" +.SH NAME +yt \- command-line tool allowing to access some of yt's basic functionality without opening a python interpreter. +.SH DESCRIPTION +The tools is a collection of subcommands. These can quickly making plots of +slices and projections through a dataset, updating yt's codebase, print +basic statistics about a dataset, launch an IPython notebook session, and more. +.TP +usage: yt [\-h] [\-\-config CONFIG] [\-\-paste] [\-\-paste\-detailed] [\-\-detailed] [\-\-rpdb] [\-\-parallel] [\-\-version] subcommand +.PP +yt command line arguments +.SS "optional arguments:" +.TP +\fB\-h\fR, \fB\-\-help\fR +show this help message and exit +.TP +\fB\-\-config\fR CONFIG +Set configuration option, in the form param=value +.TP +\fB\-\-paste\fR +Paste traceback to paste.yt\-project.org +.TP +\fB\-\-paste\-detailed\fR +Paste a detailed traceback with local variables to +paste.yt\-project.org +.TP +\fB\-\-detailed\fR +Display detailed traceback. +.TP +\fB\-\-rpdb\fR +Enable remote pdb interaction (for parallel +debugging). +.TP +\fB\-\-parallel\fR +Run in MPI\-parallel mode (must be launched as an MPI +task) +.TP +\fB\-\-version\fR +show program's version number and exit +.SS "subcommands:" +.TP +help +Print help message +.TP +bugreport +Report a bug in yt +.TP +hub_register +Register a user on the Hub: http://hub.yt\-project.org/ +.TP +instinfo +Get some information about the yt installation +.TP +version +Get some information about the yt installation +.TP +load +Load a single dataset into an IPython instance +.TP +mapserver +Serve a plot in a GMaps\-style interface +.TP +pastebin +Post a script to an anonymous pastebin +.TP +pastebin_grab +Print an online pastebin to STDOUT for local use. +.TP +upload_notebook +Upload an IPython notebook to hub.yt\-project.org. +.TP +plot +Create a set of images +.TP +rpdb +Connect to a currently running (on localhost) rpd +session. Commands run with \fB\-\-rpdb\fR will trigger an rpdb +session with any uncaught exceptions. +.TP +notebook +Run the IPython Notebook +.TP +stats +Print stats and max/min value of a given field (if +requested), for one or more datasets (default field is +density) +.TP +update +Update the yt installation to the most recent version +.TP +upload_image +Upload an image to imgur.com. Must be PNG. +.SH AUTHORS +.B yt +was primarily written by yt Development Team. +.SH "SEE ALSO" +Full documentation for the +.B yt +commandline can be found at http://yt-project.org/doc/ diff --git a/doc/yt_lodgeit.1 b/doc/yt_lodgeit.1 new file mode 100644 index 0000000..4083da8 --- /dev/null +++ b/doc/yt_lodgeit.1 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.3. +.TH YT_LODGEIT.PY "1" "April 2016" "yt_lodgeit.py 3.2.3-1" "User Commands" +.SH NAME +yt_lodgeit.py \- yt_lodgeit - pastebin tool for yt +.SH SYNOPSIS +.B yt_lodgeit.py +[\fI\,options\/\fR] [\fI\,FILE \/\fR...] +.SH DESCRIPTION +Read the files and paste their contents to http://paste.yt\-project.org/. +If no file is given, read from standard input. +If multiple files are given, they are put into a single paste. +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +show this help message and exit +.TP +\fB\-v\fR, \fB\-\-version\fR +Print script version +.TP +\fB\-L\fR, \fB\-\-languages\fR +Retrieve a list of supported languages +.TP +\fB\-l\fR LANGUAGE, \fB\-\-language\fR=\fI\,LANGUAGE\/\fR +Used syntax highlighter for the file +.TP +\fB\-e\fR ENCODING, \fB\-\-encoding\fR=\fI\,ENCODING\/\fR +Specify the encoding of a file (default is utf\-8 or +guessing if available) +.TP +\fB\-b\fR, \fB\-\-open\-browser\fR +Open the paste in a web browser +.TP +\fB\-p\fR, \fB\-\-private\fR +Paste as private +.TP +\fB\-\-no\-clipboard\fR +Don't copy the url into the clipboard +.TP +\fB\-\-download\fR=\fI\,UID\/\fR +Download a given paste +.SH "SEE ALSO" +The full documentation for +.B yt_lodgeit.py +is maintained as a Texinfo manual. If the +.B info +and +.B yt_lodgeit.py +programs are properly installed at your site, the command +.IP +.B info yt_lodgeit.py +.PP +should give you access to the complete manual. -- 2.30.2