Debian Codegraph @

man/stap-jupyter.1

raw
1 .\" -*- nroff -*-
2 .TH STAP-JUPYTER-* 1
3 .SH NAME
4 stap-jupyter-install \- locally install isystemtap
5
6 stap-jupyter-container \- manage an isystemtap container image
7
8 .\" macros
9 .de SAMPLE
10
11 .nr oldin \\n(.i
12 .br
13 .RS
14 .nf
15 .nh
16 ..
17 .de ESAMPLE
18 .hy
19 .fi
20 .RE
21 .in \\n[oldin]u
22
23 ..
24
25 .SH SYNOPSIS
26 \fBstap-jupyter-install\fR
27 [\fB--remove\fR]
28 [\fB--container-install\fR \fIPREFIX\fR]
29
30 \fBstap-jupyter-container\fR
31 [\fB--repo\fR \fIREPOSITORY\fR]
32 [\fB--image\fR \fIIMAGE\fR]
33 [\fB--tag\fR \fITAG\fR]
34 [\fB--keyname\fR \fIKEYNAME\fR]
35 --{\fBrun\fR, \fBpull\fR, \fBbuild\fR, \fBpublish\fR, \fBremove\fR}
36
37 .SH DESCRIPTION
38 ISystemtap is an interactive jupyter interface for the incremental writing and running
39 of Systemtap scripts.
40
41 The \fIstap-jupyter-install\fR program can be used to locally install the ISystemtap
42 jupyter kernel, language-server and jupyter-lab extension in ~/.systemtap/jupyter.
43 Once installed, the kernel can be used with \fIjupyter-lab\fR.
44
45 Alternatively the \fIstap-jupyter-container\fR program can be used to run ISystemtap
46 within a container, preventing the need for any local jupyter kernel installation.
47
48 .SH INSTALL OPTIONS
49 The following options are supported by stap-jupyter-install. Any other option prints a short help
50 message.
51 .IP "\fB--remove\fR"
52 Uninstall the local ISystemtap files.
53 .IP "\fB--container-install\fR \fIPREFIX\fR"
54 \fB[Intended For Maintainers Only]\fR This is used to specify the \fIPREFIX\fR of the install
55 directory for \fIstap\fR. It is called within the container build process, and should not
56 be used otherwise.
57 .SH CONTAINER OPTIONS
58 The following options are supported by stap-jupyter-container. Any other option prints a short help
59 message.
60 .IP "\fB--repo\fR \fIREPOSITORY\fR"
61 Specify which repository to use, defaults to "quay.io".
62 .IP "\fB--image\fR \fIIMAGE\fR"
63 Specify the image name. Defaults to "systemtap/isystemtap"
64 .IP "\fB--tag\fR \fITAG\fR"
65 Specify the image tag. Defaults to "latest"
66 .IP "\fB--keyname\fR \fIKEYNAME\fR"
67 In order for the container to run \fIstap\fR it needs to \fIssh\fR to the host. It requires
68 an ssh key pair, and is specified by \fIKEYNAME\fR, which is by default "id_rsa".
69
70 .SH CONTAINER COMMANDS
71 The following commands are recognized by stap-jupyter-container. One of the following
72 is required.
73 .IP "\fB--run\fR"
74 Run the image. Pulls if not done already.
75 .IP "\fB--pull\fR"
76 Pulls the image.
77 .IP "\fB--build\fR"
78 Builds a local copy of the image. The repo will be "localhost". See \fIpodman\fR images.
79 .IP "\fB--remove\fR"
80 Removes the image.
81 .IP "\fB--publish\fR"
82 \fB[Intended For Maintainers Only]\fR This is used to publish the built image. It
83 requires write permissions to
84 .nh
85 https://quay.io/systemtap/isystemtap.
86 .hy
87
88 .SH SEE ALSO
89 .nh
90 .nf
91 .IR stap (1),
92 .IR podman (1)
93 .IR ssh (1)
94
95 .SH BUGS
96 Use the Bugzilla link of the project web page or our mailing list.
97 .nh
98 .BR http://sourceware.org/systemtap/ , <[email protected]> .
99 .hy