alias: alias [name[=value]]
With no arguments, print the list of aliases in the form alias name='value'.
Otherwise, an alias is defined for each name whose value is given.
Example:
alias x='echo hello'
alias
x
basename: basename path
Return the file name portion of a path.
Example:
basename /a/b/c.d # return c.d
cd: cd [path]
Change the current directory to path. Without argument it goes in ${HOME}
on UNIXes (including CYGWIN) and ${USERPROFILE} on Windows from a DOS prompt.
compgen: compgen [-cbae] -c list all aliases, builtins and other commands. -b list all builtins. -a list all aliases. -e list all environment variables.
cp: cp source target Copy the contents of source file in the target file. If target is ., a file with name being the source base name will be created in the current directory.
date: date Print date and time.
dirname: dirname path
Return the directory portion of a path.
Example:
dirname /a/b/c.d # return /a/b
echo: [-n] [arg ...] Output the args. If -n is specified, the trailing newline is suppressed.
exit: exit Causes a not sourced file to exit. In interactives mode, it stops the shell.
export: export [name[=value]]
name is marked for automatic export to the environment.
If no name is given, a list of all names that are exported
is printed.
Example:
a=b
export a
export a=b
export
help: help [command] Display informations about a command.
helps: helps [-doxygen] Print the help text of known commands. -doxygen permits to print at some doxygen format.
history: history [-c] [n] Display the history list with line numbers. Argument of n says to list only the last n lines. The -c option causes the history list to be cleared by deleting all of the entries.
let: let arg
arg is an arithmetic expression to be evaluated.
Evaluation is done in double.
Example:
let x=2+3
let x=2.0/3.0
let x=cos(3.1416)
echo ${x}
mkdir: mkdir [-p] name
Create directory name.
-p permits to create intermediate directories if needed.
Example:
mkdir my_dir
mkdir -p dir_0/dir_1/my_dir
printenv: printenv [name]
The printenv utility prints out the names and values of the variables in the environment,
with one name/value pair per line. If name is specified, only its value is printed.
Example:
printenv
printenv HOME
pwd: pwd
Print the current working directory.
return: return Causes a sourced file to exit.
rm: rm path Remove the file specified by path.
set: set [-+v,-+x,-+n,-+d]
-v print shell input lines as they are read.
-x print commands and their arguments as they are executed.
-n read commands but do not execute them.
-d pass in debug mode.
Using + rather than - causes these flags to be turned off.
Without options, all shell variables are printed.
Example:
set -v
set +v
set
suffix: suffix path
Return the suffix portion of a path.
Example:
suffix /a/b/c.d # return d
time: time command Execute command and print the real time spent executing it.
type: type [-t] name [name ...] For each name, indicate how it would be interpreted if used as a command name. If the -t option is used, it outputs a single word which is one of [alias, builtin, compiled, file, unfound] if the name is an alias, shell builtin, other compiled command, a file or is unfound.
unalias: unalias [-a] name Remove name from the list of defined aliases. -a removes all aliases.
unset: unset variable Remove the corresponding variable.
app_dir: app_dir [-res,-doc,-out,-tmp,-start].
Print the application [resource,document,output,startup,temporary] directory.
If no option given, print all of them in this order.
Example:
app_dir
app_dir -res.
open: open [-doc,-res,-doc_res] path
Attempt to open a file. The known file types depend of the "openers" declared to the app.
If no directory is given in path, the -doc_res option permits to search a file first
in the document directory declared to the app, and then in the app (internal) resource directory.
-res for the resource directory only, -doc for the document directory only.
See also:
app_dir -res
app_dir -doc.
open_event_file: open_event_file [-doc_res,-res,-doc] path Open a root event file. If no directory is given in path, the -doc_res option permits to search a file first in the document directory declared to the app, and then in the app (internal) resource directory. -res for the resource directory only, -doc for the document directory only. See also : app_dir.
open_geometry_file: open_geometry_file [-doc_res,-res,-doc] path Open a root geometry file. If no directory is given in path, the -doc_res option permits to search a file first in the document directory declared to the app, and then in the app (internal) resource directory. -res for the resource directory only, -doc for the document directory only. See also : app_dir.
openers: openers [-exts] List operners known by the application. -exts permits to list the known file extensions.
calc: calc [formula] [variable values]
Expression evaluator.
Example:
calc 2+2
calc cos(x) 3.14
calc x/y 4 2
camera_pitch: camera_pitch [-deg,-degree] value Rotate the camera around the left-right/x axis. If specifying -deg or -degree, the value is taken in degrees.
camera_reset: camera_reset Reset camera parameters. It is usefull if being lost in space.
camera_roll: camera_roll [-deg,-degree] value Rotate the camera around the direction of view axis. If specifying -deg or -degree, the value is taken in degrees.
camera_rotate: camera_rotate [-x,-y,-z] [-at_focal] [-deg,-degree] [-angle=angle]
Rotate the camera around an axis of the given angle.
If -deg or -degree is specified, the angle is in degree (default is then radian).
If -at_focal is given, the center of rotation if the focal point, else
it is the current camera position.
-x or -y or -z specifies the axis of rotation (one must be specified).
The frame follows the usual OpenGL convention : x axis points to the right,
y axis points to the up direction and the z axis is pointing off the screen.
Example:
camera_rotate -z -deg -angle=-20 # to roll by -20 degrees.
camera_set_da: camera_set_da value Set the rotation step factor in radians (default 0.017).
camera_set_ds: camera_set_ds value Set the zoom step factor (default 0.99).
camera_set_dx: camera_set_dx value Set the translation step factor (default 0.01).
camera_set_focal: camera_set_focal value Set the camera focal length (default 1).
camera_set_orientation: camera_set_orientation x y z angle Set camera.orientation = rotf(vec3f(x,y,z),angle).
camera_set_ortho: camera_set_ortho height
Replace the current camera by an orthographic camera of given height.
Example:
camera_set_ortho 4
camera_set_perspective: camera_set_perspective angle
Replace the current camera by a perspective camera with angle (in radians) height_angle.
Example:
camera_set_perspective 0.785 # pi/4.
camera_set_position: camera_set_position x y z
Set camera.position to be x,y,z.
Example:
camera_set_position 0 0 10
camera_set_zfar: camera_set_zfar value Set the camera zfar (default 10). zfar is the distance toward the backward cut plan.
camera_set_znear: camera_set_znear value Set the camera znear (default 1). znear is the distance toward the forward cut plan.
camera_start_anim: camera_start_anim [-cycle_secs=secs] anim
Start a camera animation. The anim argument could be :
move_rotate_right
move_rotate_left
move_rotate_up
move_rotate_down
move_roll_plus
move_roll_minus
move_translate_right
move_translate_left
move_up
move_down
move_forward
move_backward
move_zoom_in
move_zoom_out
move_rotate_around_focal_right
move_rotate_around_focal_left
move_rotate_around_focal_up
move_rotate_around_focal_down
move_roll_around_focal_plus
move_roll_around_focal_minus
move_zoom_in_out
move_zoom_in_out_rot
move_curve
For move_zoom_in_out, move_zoom_in_out_rot and move_curve, the -cycle_secs option
permits to set the cycle time in seconds (it is 10 secs by default).
Use camera_stop_anim to stop the animation.
camera_stop_anim: camera_stop_anim, If any on, stop a camera animation.
camera_swap_kind: camera_swap_kind Swap camera between ortho and perspective.
camera_translate_position: camera_translate_position x y z
Translate the camera.position by x,y,z.
Example:
camera_translate_position 10 20 30
camera_view_all: camera_view_all Arrange the camera so that all the scene elements are viewed.
camera_yaw: camera_yaw [-deg,-degree] value Rotate the camera around the up axis. If specifying -deg or -degree, the value is taken in degrees.
camera_zoom: camera_zoom factor
Zoom in or out camera.
Example:
camera_zoom 0.99 # is a zoom in.
camera_zoom 1.01 # is a zoom out.
event_count: event_count item [cut].
Count event model item instances.
Someone can give a cut in option.
Without any argument, the event model items are printed.
Example :
event_count
event_count MCTrack
event_count MCTrack -cut=pdg==50000050
event_exec_insh: event_exec_insh Source the event.insh script.
event_fields: event_fields item.
Print event model item fields.
Without any argument, the event model items are printed.
Example :
event_fields
event_fields MCTrack
event_index: event_index Print the event index.
event_model: event_model [class]
Print event model items along with their fields.
If a class is given, print the fields of this class.
Fields permit, for example, to pass cut in event_vis,
event_count, event_stats, event_print, event_plot commands.
Examples:
event_model
event_model MCTrack
Related examples:
event_vis MCTrack -cut=(pdg==50000050) -color=red
event_vis MCTrack -cut=name=="'opticalphoton'" -color=blue
event_plot MCTrack -cut=(pdg!=50000050) -filling=p
event_print WCDetectorPoint -cut=index<10 x y z p
event_next: event_next Get next event in file and source the event.insh script.
event_plot: event_plot item [cut] field.
Plot field of event model item instances.
Someone can give a cut in option.
Without any argument, the event model items are printed.
Example :
event_plot
event_plot MCTrack -filling=p
event_plot MCTrack -cut=pdg==50000050 -filling=t
event_print: event_print item [cut] [fields].
Print event model item fields.
Someone can give a cut in option and a list of fields.
If no field is given, all are considered.
Without any argument, the event model items are printed.
Example :
event_print
event_print MCTrack
event_print MCTrack -cut=pdg==50000050 x y z p
event_stats: event_stats item [cut] [fields].
Print event model item fields min/max/mean/rms.
Someone can give a cut in option and a list of fields.
If no field is given, all are considered.
Without any argument, the event model items are printed.
Example :
event_stats
event_stats MCTrack
event_stats MCTrack -cut=pdg==50000050 x y z p
event_stop_anim: event_stop_anim Stop the looping on events animation.
event_time_max: event_time_max Print event max time taking the max of all MCTrack.t, WCDetectorPoint.time and FgdDetectorPoint.time
event_time_min: event_time_min Print event min time taking the min of all MCTrack.t, WCDetectorPoint.time and FgdDetectorPoint.time
event_vis: event_vis item [cut].
Visualize event model item instances.
Someone can give a cut in option.
Without any argument, the event model items are printed.
Example :
event_vis
event_vis MCTrack
event_vis MCTrack -cut=pdg==50000050
fard_set_camera: fard_set_camera Set camera for the fard.
fard_vis_floor: fard_vis_floor Add a grid floor in the fard setup.
fard_vis_geometry: fard_vis_geometry Add the fard geometry in the static scene graph.
fard_vis_sarah: fard_vis_sarah Add the sarah avatar in the fard setup.
fgd_vis_geometry: fgd_vis_geometry Add the fgd geometry in the static scene graph.
gui_exec_main_menu_item: gui_exec_main_menu_item menu_item_label
Given its label, find a menu item in the
current main menu and execute its callback.
Example:
gui_exec_main_menu_item exit
gui_hide_camera_menu: gui_hide_camera_menu Hide the camera menu items.
gui_hide_console: gui_hide_console Hide the upper left console text.
gui_hide_main_menu: gui_hide_main_menu Hide the main menu and show the scene.
gui_hide_meta_zone: gui_hide_meta_zone Hide the light blue area at the bottom of the window that permits to switch between scene mode and main menu mode.
gui_push_back_item: gui_push_back_item If being in a submenu of the main menu, return to the parent menu.
gui_push_home: gui_push_home Show the top list items in the main menu.
gui_scroll_text: gui_scroll_text [strings] Show strings in a scrolling text widget. gui_scroll_text line_1 line_2 line_3 line_4 line_5 line_6 gui_show_main_menu
gui_set_console_layout: gui_set_console_layout [width] [height] [scale].
Set the console width and/or height. -scale can set an extra scaling factor.
Width and height are in normal window coordinates (in [0,1]).
Example:
gui_set_console_layout -width=0.5 -height=0.06 -scale=1.2
gui_set_console_layout -width=0.5 # half window width.
gui_set_console_layout -scale=2
gui_set_console_layout # reset default layout (width=0.3, height=0.05, scale=1)
gui_set_picking_mode: gui_set_picking_mode When in scene mode, pass the cursor/touching in picking mode. It permits to pick an object and have a contextual popup on it.
gui_set_to_exit: gui_set_to_exit Raise the application exit flag.
gui_set_viewing_mode: gui_set_viewing_mode When in scene mode, pass the cursor/touching in viewing mode. It permits to move the camera with the mouse/touches.
gui_show_camera_menu: gui_show_camera_menu Show the camera menu items.
gui_show_console: gui_show_console Show the upper left console text.
gui_show_main_menu: gui_show_main_menu Show the main menu.
gui_text: gui_text [strings] Show strings in a text widget. gui_text line_1 line_2 line_3 gui_show_main_menu
ls: ls [option] directory list directory contents. If no directory is given, the current directory is listed. By default the dotted files are not listed, use -a to list all files. Use -l to list with a long format.
neard_set_camera: neard_set_camera Set camera for the neard.
neard_vis_floor: neard_vis_floor Add a grid floor in the neard setup.
neard_vis_geometry: neard_vis_geometry Add the neard geometry in the static scene graph.
neard_vis_sarah: neard_vis_sarah Add the sarah avatar in the neard setup.
particle_print: particle_print [-cut] fields
If no fields are given, list all them.
-cuts permit to do selection in particles.
Example:
particle_print
particle_print -cut=code==11 name mass charge # print name, mass and charge of electron.
particle_print -cut=name=="'~mu_L+'" code mass charge # print pid, mass and charge of ~mu_L+.
pdg: pdg [-version, -names, -pids, -ls, -pids_ls] [pids] [names]
If no argument given, list all pdg (particle data group) table.
If a list of integers or strings are given, particles with pdg_code (pid)
or name are searched and printed.
-names print particle names on one column.
-pids print pdg_codes on one column.
-ls print particle names by using a unix ls like format.
-pids_ls print particle pdg_codes by using a a unix ls like format.
-version print the pdg file used to get data.
Example:
pdg -ls
pdg 12 nu_e_bar
plots_full_window: plots_full_window Set scene ready for full window plotting.
plots_hide: plots_hide Hide the scene plotting area.
plots_set_current_region: plots_set_current_region index.
Set the current region index in the first sg::plots node found in the scene.
index is in [0,number of regions[.
Example:
plots_set_regions 2 2 # then four regions.
plots_set_current_region 3 # then the bottom right region will be the current one.
plots_set_layout_factors: plots_set_layout_factors x y scale_x scale_y
Set the set the positionning and size of the first sg::plots node found in the scene.
x, y, scale_x and scale_y are in normal window coordinates (in [0,1]).
Example:
plots_set_layout_factors 0.3 0.35 0.3 0.2 # up right.
plots_set_layout_factors 0.28 -0.28 0.4 0.4 # defaults. down right.
plots_set_regions: plots_set_regions cols rows [transfer].
Set the grid of inlib::sg::plotters in the first inlib::sg::plots node found in the scene.
The optional transfer argument (false by default) says is the content of
previous plotters are to be transfered in the plotter in the new grid.
Example:
plots_set_regions 2 2 # then four regions are created.
plots_set_regions 2 3 true
plots_show: plots_show Show the scene plotting area.
scene_add_insh_anim: scene_add_insh_anim [options]
Add an insh_anim node in the dynamic scene graph.
-file=string insh file sourced during the animation (default anim.insh).
-time_min=real event time start (in nsecs).
-time_max=real event time end (in nsecs).
-delay=real user elapsed time of the anim in secs.
-end_begin=bool if true, start again at end (default is false).
-show_console=bool if true, show timing infos in the console (default is true).
-scene_clear_dynamic=bool if true, clear dynamic scene graph before starting.
WARNING, IMPORTANT, ACHTUNG, ATTENZIONE:
You must NOT do a scene_clear_dynamic in an anim script because
the insh_anim node is deposited in the dynamic scene graph.
The variables insh_anim_time_begin, insh_anim_time_end are defined at each time slice.
They permit to put, from the anim script, the related data in the scene graph.
Example:
scene_add_insh_anim -time_min=0 -time_max=25 -delay=10 -end_begin=false -file=anim.insh
with, in the anim.insh script:
mc_cut_time="(${insh_anim_time_begin}<=t)&&(t<${insh_anim_time_end})"
event_vis MCTrack -cut=${mc_cut_time} -color=red
scene_add_xy_grid: scene_add_xy_grid [options]
Add a wire-frame grid in the static scene graph.
-color=string color of the grid (default lightgrey).
-line_width=real line width (default 1).
-sx=real x size of each cell (default 0.1).
-sy=real y size of each cell (default 0.1).
-nx=uint x number of cells (default 10).
-ny=uint y number of cells (default 10).
-scale=real overall scale (default 1).
-rotate='real real real real' overall rotation (default '0 0 1 0'). First
three numbers specify the axis, the last one the angle in radians.
-transtale='real real real' overall translation of the grid (default '0 0 0').
Scale, rotation, translation are applied in this order.
Example:
scene_add_xy_grid -color=lightgrey -line_width=1 -translate='0 -300 0' -rotate='1 0 0 1.570796' -sx=100 -nx=10 -sy=100 -ny=10
scene_blend_off: scene_blend_off Switch off the overall blending (and then transparency).
scene_blend_on: scene_blend_on Switch on the overall blending (and then transparency).
scene_bounding_box: scene_bounding_box
Print the center and size of the scene bounding box.
Example:
scene_bounding_box
scene_clear_dynamic: scene_clear_dynamic Clear the dynamic scene graph.
scene_clear_static: scene_clear_static Clear the static scene graph.
scene_count_points: scene_count_points Count number of points in the scene.
scene_light_off: scene_light_off Switch off the overall light.
scene_light_on: scene_light_on Switch on the overall light.
scene_read_bsg: scene_read_bsg [-file,-scale,-translate,-rotate]
Read a bsg file and add its contents in the static scene graph.
-file=string file at the bsg (binary scene graph) format. The file is searched first
in the document directory of the application, then in its resource directory.
-scale=real overall scale (default 1).
-rotate='real real real real' overall rotation (default '0 0 1 0'). First
three numbers specify the axis, the last one the angle in radians.
-transtale='real real real' overall translation (default '0 0 0').
Scale, rotation, translation are applied in this order.
Example:
scene_read_bsg -file=avatar_plant.bsg -translate='460 -300 430' -rotate='0 1 0 -1.570796' -scale=0.03
scene_set_clear_color: scene_set_clear_color [color name] [colormap/color name] [#rrggbb] [r g b] [r g b a]
Set the color of the background of the scene.
It can be given by a common color name in the default colormap,
by giving the name of a color in a known colormap, by giving an hexa encoding or by giving
the three or four r,g,b,a (in [0,1]) of the color.
See style_print_colormaps to print the known colormaps with their colors.
Example:
scene_set_clear_color lightgrey
scene_set_clear_color ROOT/kMagenta+3
scene_set_clear_color '#FFFF00'
scene_set_clear_color 0.2 0.1 0.2
scene_write_dynamic_to_bsg: scene_write_dynamic_to_bsg [-out_dir] file
Write the dynamic scene graph to a bsg (binary file format) file.
If no directory is given in file, the -out_dir option permits to prepend the
application output directory to file.
See also: app_dir -out_dir
Example:
scene_write_dynamic_to_bsg -out_dir my_scene.bsg
scene_write_static_to_bsg: scene_write_static_to_bsg [-out_dir] file
Write the static scene graph to a bsg (binary file format) file.
If no directory is given in file, the -out_dir option permits to prepend the
application output directory to file.
See also: app_dir -out_dir
Example:
scene_write_static_to_bsg -out_dir my_scene.bsg
scene_write_to_bsg: scene_write_to_bsg [-out_dir] file
Write the scene scene graph to a bsg (binary file format) file.
If no directory is given in file, the -out_dir option permits to prepend the
application output directory to file.
See also: app_dir -out_dir
Example:
scene_write_to_bsg -out_dir my_scene.bsg
scene_write_to_paper: scene_write_to_paper [-out_dir] [-scale] [-format] [-show_console] file
Produce an output file from the current scene.
-out_dir permits to write the file in the output directory of the application.
-scale permits to scale the viewport; it allows to have a better rendering for freetype fonts.
-show_console prints the name of the output file in the console.
-format permits to choose the output format and the tool to produce the file.
If 'guessed', which is the default, the format is choosen/deduced from the file extension.
For example for out.png, the format will be inzb_png.
The known formats are:
inzb_[ps,png,jpeg] : pixmap of the scene is put in a PostScript, png or jpeg file
by using the inlib::sg::zb_action.
gl2ps_[eps,ps,pdf,svg,tex,pdg] : primitives of the scene (vector graphices) is put in an
encapsulated PostScript, PostScript, PDF, SVG, LaTeX or PDG file by using gl2ps.
If 'guessed' is used as format, then according to the file extension, the tool used is:
.ps, .eps: inzb_ps
.png : inzb_png
.jpg, .jpeg: inzb_jpeg
.pdf, .svg, .pgf, .tex: gl2ps_[pdf,svg,pgf,tex]
Example:
scene_write_to_paper out.jpeg # produce a out.jpeg file in current directory by using inzb_jpeg.
scene_write_to_paper -out_dir -format=inzb_png -scale=2 out.png
scene_write_to_paper -format=gl2ps_pdf out.pdf
scene_write_to_paper -format=guessed -show_console out.pgf
See also:
app_out_dir
style_load_file: style_load_file [-doc_res,-res,-doc] path Load a XML style file. If no directory is given in path, the -doc_res option permits to search a file first in the document directory declared to the app, and then in the app (internal) resource directory. -res for the resource directory only, -doc for the document directory only. See also : app_dir.
style_print_colormaps: style_print_colormaps Print the known colormaps.
sys_file_sep: sys_file_sep Print the file separator. It is / on UNIX and \ on Windows.
sys_home_dir: sys_home_dir Print the home directory.
sys_path_sep: sys_path_sep Print the path separator. It is : on UNIX and ; on Windows.
tput: tput [cols,lines]
Print terminal width or height.
Example:
tput cols
tput lines
window_render: window_render Enforce an immediate rendering of the window.
window_to_jpeg: window_to_jpeg [-hide_camera_menu] [path]
Produce a jpeg file from the displayed window contents.
If no path is given, a out.jpeg file is produced in the output directory of the application.
-hide_camera_menu permits to hide the camera menu panel before writing.
Note that no alpha channel is written in the jpeg, if you want it, use the window_to_png command.
Example:
window_to_jpeg out.jpeg # to produce an out.jpeg in the current directory
See also:
app_out_dir
window_to_png
window_to_png: window_to_png [-hide_camera_menu] [-bpp] [path]
Produce a png file from the displayed window contents.
If no path is given, a out.png file is produced in the output directory of the application.
-hide_camera_menu permits to hide the camera menu panel before writing.
-bpp permits to choose to produce three or four bytes per pixel (rgb or rgba).
It is four by default. It permits to save transparency/blending in the png.
Example:
window_to_png -bpp=3 out.png # to produce an out.png in the current directory
See also:
app_out_dir