void cmp_surf_usage ()
{
printf ("\nUsage: SUMA_inflate_compare \n\t-spec <Spec file>\n\n");
printf ("\n\t-spec <Spec file>: File containing surface specification. This file is typically \n");
printf ("\t generated by @SUMA_Make_Spec_FS (for FreeSurfer surfaces) or \n");
printf ("\t @SUMA_Make_Spec_SF (for SureFit surfaces). The Spec file should \n");
printf ("\t be located in the directory containing the surfaces.\n");
printf ("\n\t-hemi <left or right>: specify the hemisphere being processed \n");
printf ("\n\t[-prefix <fileprefix>]: Prefix for distance and node color output files.\n");
printf ("\t This option is optional. Existing file will not be overwritten.\n");
printf ("\n\t-box <wX wY wZ>: restrict intersection computations for nodes \n");
printf ("\t contained in a box of w* dimensions. This might speed things\n");
printf ("\t up sometimes if the box dimension needs not be large.\n");
printf ("\t This option is pretty much useless.\n");
/*
printf ("\n\t[-dev]: This option will give access to options that are not well polished for consumption.\n");
printf ("\n\t \n");
*/
printf ("\n\n\tFor more help: http://afni.nimh.nih.gov/ssc/ziad/SUMA/SUMA_doc.htm\n");
printf ("\n\n\tIf you can't get help here, please get help somewhere.\n");
SUMA_Version(NULL);
printf ("\n\t Shruti Japee LBC/NIMH/NIH [email protected] Ziad Saad SSSC/NIMH/NIH [email protected] \n\n");
exit (0);
}
void SUMA_usage (SUMA_GENERIC_ARGV_PARSE *ps, int detail)
{/*Usage*/
char *sb = NULL, *sio = NULL, *ssym=NULL;
ssym = SUMA_help_SPEC_symbolic();
sb = SUMA_help_basics();
sio = SUMA_help_IO_Args(ps);
printf (
"\nUsage: \n"
" Mode 0: Just type suma to see some toy surface and play\n"
" with the interface. Some surfaces are generated\n"
" using T. Lewiner's MarchingCubes library. \n"
" Use '.' and ',' keys to cycle through surfaces.\n"
"\n"
" Mode 1: Using a spec file to specify surfaces\n"
" suma -spec <Spec file> \n"
" [-sv <SurfVol>] [-ah AfniHost]\n"
"\n"
" Mode 2: Just show me the money\n"
" suma <-i SomeSurface> \n"
" [-sv <SurfVol>] [-ah AfniHost]\n"
"\n"
"\n%s", detail ? "":"use -h or -help for more help detail.\n");
if (detail) {
printf (
" Mode 1:\n"
" -spec <Spec file>: File containing surface specification. \n"
" This file is typically generated by \n"
" @SUMA_Make_Spec_FS (for FreeSurfer surfaces) or \n"
" @SUMA_Make_Spec_SF (for SureFit surfaces). \n"
" The Spec file should be located in the directory \n"
" containing the surfaces.\n"
"%s\n"
" [-sv <SurfVol>]: Anatomical volume used in creating the surface \n"
" and registerd to the current experiment's anatomical \n"
" volume (using @SUMA_AlignToExperiment). \n"
" This parameter is optional, but linking to AFNI is \n"
" not possible without it.If you find the need for it \n"
" (as some have), you can specify the SurfVol in the \n"
" specfile. You can do so by adding the field \n"
" SurfaceVolume to each surface in the spec file. \n"
" In this manner, you can have different surfaces using\n"
" different surface volumes.\n"
" [-ah AfniHost]: Name (or IP address) of the computer running AFNI. \n"
" This parameter is optional, the default is localhost.\n"
" When both AFNI and SUMA are on the same computer, \n"
" communication is through shared memory. \n"
" You can turn that off by explicitly setting AfniHost\n"
" to 127.0.0.1\n"
" [-niml]: Start listening for communications with NIML-formatted elements.\n"
" Environment variable SUMA_START_NIML can also be used to start\n"
" listening.\n"
" [-noniml]: Do not start listening for communications with NIML-formatted\n"
" elements, even if env. SUMA_START_NIML is set to YES\n"
"\n"
" Mode 2: Using -t_TYPE or -t* options to specify surfaces on command line.\n"
" -sv, -ah, -niml and -dev are still applicable here. This mode \n"
" is meant to simplify the quick viewing of a surface model.\n"
" suma [-i_TYPE surface] [-t* surface] \n"
" Surfaces specified on command line are place in a group\n"
" called 'DefGroup'.\n"
" If you specify nothing on command line, you will have a random\n"
" surface created for you. Some of these surfaces are generated\n"
" using Thomas Lewiner's sample volumes for creating isosurfaces.\n"
" See suma -sources for a complete reference.\n"
"\n"
"%s"
"\n"
" Modes 1 & 2: You can mix the two modes for loading surfaces but the -sv\n"
" option may not be properly applied.\n"
" If you mix these modes, you will have two groups of\n"
" surfaces loaded into SUMA. You can switch between them\n"
" using the 'Switch Group' button in the viewer controller.\n"
"\n"
"%s"
/*" [-iodbg] Trun on the In/Out debug info from the start.\n"
" [-memdbg] Turn on the memory tracing from the start.\n" */
" [-visuals] Shows the available glxvisuals and exits.\n"
" [-brethren_windows] For Testing Only. Show a listing of windows possibly \n"
" related to AFNI and SUMA.\n"
" [-version] Shows the current version number.\n"
" [-environment] Shows a list of all environment variables, \n"
" their default setting and your current setting.\n"
" The output can be used as a new .sumarc file.\n"
" Since it takes into consideration your own settings\n"
" this command can be used to update your .sumarc \n"
" regularly with a csh command like this:\n"
"\n"
" suma -environment > ~/sumarc && \\\n"
" cp ~/.sumarc ~/.sumarc-bak ; \\\n"
" mv ~/sumarc ~/.sumarc\n"
"\n"
"\n"
" [-drive_com DRIVE_SUMA_COM]: Drive suma with command DRIVE_SUMA_COM,\n"
" which has the same syntax that you would use for DriveSuma.\n"
" For instance:\n"
"\n"
" suma -i ld120 -drive_com '-com surf_cont -view_surf_cont y'\n"
" or \n"
" suma -drive_com '-com viewer_cont -key 'F12' -com kill_suma'\n"
"\n"
" You can use repeated instances of -drive_com to have a series\n"
" of commands that get executed in the order in which they appear\n"
" on the command line.\n"
"\n"
"\n"
"%s",
(detail > 1) ? ssym:" use -help for more detail on loading template surfaces with symbolic notation\n" ,
(detail > 1) ? sio:" use -help for more detail on input options\n" ,
(detail > 1) ? sb:" use -help for more detail on basic options\n",
(detail > 1) ? get_np_help():
" use -help for more detail on communication ports\n");
if (detail > 1) { printf(
"-help_interactive: Write the help for interactive usage into file\n"
" Mouse_Keyboard_Controls.txt\n"
"-help_sphinx_interactive HOUT: Write the help for interactive usage into \n"
" SPHINX formatted file HOUT"
"See DriveSuma's -write_*_help options for more\n"
"-test_help_string_edit: Show example of help string editing and quit\n"
"-test_help_string_edit_web: Like its prefix, but nicer for webpage.\n");
}
if (detail > 1) { printf(
" [-list_ports] List all port assignments and quit\n"
" [-port_number PORT_NAME]: Give port number for PORT_NAME and quit\n"
" [-port_number_quiet PORT_NAME]: Same as -port_number but writes out \n"
" number only\n"
" [-dev]: Allow access to options that are not well polished for\n"
" mass consuption.\n"
" [-fake_cmap]: Use X11 to render cmap. This is only needed to get colorbar\n"
" to appear when the frame is automatically captured by SUMA\n"
" for making documentation. This option has no other use.\n"
" [-update_env] Performs the set operations detailed under -environment\n"
" [-default_env] Output hard coded default environment values, ignoring\n"
" user settings.\n"
" [-latest_news] Shows the latest news for the current \n"
" version of the entire SUMA package.\n"
" [-all_latest_news] Shows the history of latest news.\n"
" [-progs] Lists all the programs in the SUMA package.\n"
" [-motif_ver] Displays the linked version of Motif.\n"
" [-sources] Lists code sources used in parts of SUMA.\n"
" [-help_nido] Help message for displayable objects of type NIDO\n"
"\n"
" For help on interacting with SUMA, press 'ctrl+h' with the mouse \n"
" pointer inside SUMA's window.\n"
" For more help: http://afni.nimh.nih.gov/pub/dist/edu/latest/suma/suma.pdf\n"
"\n"
" If you can't get help here, please get help somewhere.\n"
); }
}
SUMA_free(sb); SUMA_free(sio); SUMA_free(ssym);
if (detail) {
SUMA_Version(NULL);
printf ("\n"
"\n Ziad S. Saad SSCC/NIMH/NIH [email protected] \n\n");
}
return;
}/*Usage*/
