comparison libinterp/corefcn/pager.cc @ 17281:bc924baa2c4e

doc: Add new @qcode macro for code samples which are quoted. Macro handles options ("on") or properties ("position") more elegantly than @code{"text"}. * doc/interpreter/macros.texi: Add new @qcode macro. * doc/interpreter/tips.txi: Add documentation about @qcode macro. * doc/interpreter/basics.txi, doc/interpreter/container.txi, doc/interpreter/emacs.txi, doc/interpreter/errors.txi, doc/interpreter/eval.txi, doc/interpreter/expr.txi, doc/interpreter/external.txi, doc/interpreter/func.txi, doc/interpreter/grammar.txi, doc/interpreter/image.txi, doc/interpreter/install.txi, doc/interpreter/interp.txi, doc/interpreter/io.txi, doc/interpreter/matrix.txi, doc/interpreter/numbers.txi, doc/interpreter/oop.txi, doc/interpreter/package.txi, doc/interpreter/plot.txi, doc/interpreter/quad.txi, doc/interpreter/sparse.txi, doc/interpreter/strings.txi, doc/interpreter/system.txi, doc/interpreter/vectorize.txi, libinterp/corefcn/balance.cc, libinterp/corefcn/bitfcns.cc, libinterp/corefcn/cellfun.cc, libinterp/corefcn/conv2.cc, libinterp/corefcn/data.cc, libinterp/corefcn/debug.cc, libinterp/corefcn/defaults.cc, libinterp/corefcn/dirfns.cc, libinterp/corefcn/dlmread.cc, libinterp/corefcn/error.cc, libinterp/corefcn/file-io.cc, libinterp/corefcn/find.cc, libinterp/corefcn/gammainc.cc, libinterp/corefcn/graphics.cc, libinterp/corefcn/help.cc, libinterp/corefcn/hex2num.cc, libinterp/corefcn/input.cc, libinterp/corefcn/load-path.cc, libinterp/corefcn/load-save.cc, libinterp/corefcn/ls-oct-ascii.cc, libinterp/corefcn/lu.cc, libinterp/corefcn/luinc.cc, libinterp/corefcn/matrix_type.cc, libinterp/corefcn/oct-hist.cc, libinterp/corefcn/pager.cc, libinterp/corefcn/pr-output.cc, libinterp/corefcn/pt-jit.cc, libinterp/corefcn/qz.cc, libinterp/corefcn/rand.cc, libinterp/corefcn/regexp.cc, libinterp/corefcn/schur.cc, libinterp/corefcn/sighandlers.cc, libinterp/corefcn/sparse.cc, libinterp/corefcn/spparms.cc, libinterp/corefcn/str2double.cc, libinterp/corefcn/svd.cc, libinterp/corefcn/symtab.cc, libinterp/corefcn/syscalls.cc, libinterp/corefcn/toplev.cc, libinterp/corefcn/tril.cc, libinterp/corefcn/typecast.cc, libinterp/corefcn/utils.cc, libinterp/corefcn/variables.cc, libinterp/dldfcn/__init_fltk__.cc, libinterp/dldfcn/chol.cc, libinterp/dldfcn/colamd.cc, libinterp/dldfcn/fftw.cc, libinterp/dldfcn/qr.cc, libinterp/dldfcn/symbfact.cc, libinterp/octave-value/ov-base.cc, libinterp/octave-value/ov-fcn-handle.cc, libinterp/octave-value/ov-fcn-inline.cc, libinterp/octave-value/ov-java.cc, libinterp/octave-value/ov-range.cc, libinterp/octave-value/ov-struct.cc, libinterp/octave-value/ov-usr-fcn.cc, libinterp/parse-tree/oct-parse.in.yy, libinterp/parse-tree/pt-binop.cc, libinterp/parse-tree/pt-eval.cc, libinterp/parse-tree/pt-mat.cc, scripts/@ftp/ftp.m, scripts/deprecated/java_convert_matrix.m, scripts/deprecated/java_debug.m, scripts/deprecated/java_unsigned_conversion.m, scripts/deprecated/shell_cmd.m, scripts/general/dblquad.m, scripts/general/display.m, scripts/general/genvarname.m, scripts/general/idivide.m, scripts/general/interp1.m, scripts/general/interp2.m, scripts/general/interp3.m, scripts/general/interpn.m, scripts/general/isa.m, scripts/general/profexplore.m, scripts/general/profile.m, scripts/general/quadgk.m, scripts/general/randi.m, scripts/general/structfun.m, scripts/general/subsindex.m, scripts/general/triplequad.m, scripts/geometry/griddata.m, scripts/geometry/griddata3.m, scripts/geometry/griddatan.m, scripts/geometry/voronoi.m, scripts/help/help.m, scripts/help/lookfor.m, scripts/image/cmpermute.m, scripts/image/colormap.m, scripts/image/image.m, scripts/image/imagesc.m, scripts/image/imfinfo.m, scripts/image/imformats.m, scripts/image/imread.m, scripts/image/imshow.m, scripts/image/imwrite.m, scripts/image/ind2gray.m, scripts/image/lines.m, scripts/image/rgb2ind.m, scripts/image/spinmap.m, scripts/io/dlmwrite.m, scripts/io/strread.m, scripts/io/textread.m, scripts/io/textscan.m, scripts/java/javaclasspath.m, scripts/java/usejava.m, scripts/miscellaneous/bzip2.m, scripts/miscellaneous/computer.m, scripts/miscellaneous/copyfile.m, scripts/miscellaneous/debug.m, scripts/miscellaneous/dos.m, scripts/miscellaneous/edit.m, scripts/miscellaneous/gzip.m, scripts/miscellaneous/license.m, scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/movefile.m, scripts/miscellaneous/parseparams.m, scripts/miscellaneous/unix.m, scripts/optimization/fminbnd.m, scripts/optimization/fminsearch.m, scripts/optimization/fminunc.m, scripts/optimization/fsolve.m, scripts/optimization/fzero.m, scripts/optimization/glpk.m, scripts/optimization/lsqnonneg.m, scripts/optimization/optimset.m, scripts/optimization/pqpnonneg.m, scripts/pkg/pkg.m, scripts/plot/allchild.m, scripts/plot/ancestor.m, scripts/plot/area.m, scripts/plot/axis.m, scripts/plot/bar.m, scripts/plot/barh.m, scripts/plot/box.m, scripts/plot/caxis.m, scripts/plot/cla.m, scripts/plot/clabel.m, scripts/plot/clf.m, scripts/plot/close.m, scripts/plot/colorbar.m, scripts/plot/daspect.m, scripts/plot/ezmesh.m, scripts/plot/ezmeshc.m, scripts/plot/ezsurf.m, scripts/plot/ezsurfc.m, scripts/plot/findall.m, scripts/plot/findobj.m, scripts/plot/gcbo.m, scripts/plot/gcf.m, scripts/plot/gco.m, scripts/plot/grid.m, scripts/plot/guihandles.m, scripts/plot/hdl2struct.m, scripts/plot/hidden.m, scripts/plot/hold.m, scripts/plot/isonormals.m, scripts/plot/isosurface.m, scripts/plot/legend.m, scripts/plot/mesh.m, scripts/plot/meshc.m, scripts/plot/meshz.m, scripts/plot/newplot.m, scripts/plot/orient.m, scripts/plot/pareto.m, scripts/plot/patch.m, scripts/plot/pbaspect.m, scripts/plot/pcolor.m, scripts/plot/plot.m, scripts/plot/print.m, scripts/plot/private/__add_default_menu__.m, scripts/plot/quiver.m, scripts/plot/quiver3.m, scripts/plot/refreshdata.m, scripts/plot/saveas.m, scripts/plot/scatter.m, scripts/plot/scatter3.m, scripts/plot/shading.m, scripts/plot/shrinkfaces.m, scripts/plot/slice.m, scripts/plot/stem.m, scripts/plot/stem3.m, scripts/plot/struct2hdl.m, scripts/plot/subplot.m, scripts/plot/surf.m, scripts/plot/surfc.m, scripts/plot/surfl.m, scripts/plot/tetramesh.m, scripts/plot/uigetfile.m, scripts/plot/uimenu.m, scripts/plot/uiputfile.m, scripts/plot/waterfall.m, scripts/plot/whitebg.m, scripts/plot/xlim.m, scripts/plot/ylim.m, scripts/plot/zlim.m, scripts/polynomial/conv.m, scripts/polynomial/polyout.m, scripts/polynomial/splinefit.m, scripts/set/ismember.m, scripts/set/powerset.m, scripts/set/setdiff.m, scripts/set/union.m, scripts/set/unique.m, scripts/signal/detrend.m, scripts/signal/filter2.m, scripts/signal/freqz.m, scripts/signal/periodogram.m, scripts/signal/spectral_adf.m, scripts/signal/spectral_xdf.m, scripts/sparse/eigs.m, scripts/sparse/svds.m, scripts/specfun/legendre.m, scripts/special-matrix/gallery.m, scripts/statistics/base/mean.m, scripts/statistics/base/moment.m, scripts/statistics/tests/cor_test.m, scripts/statistics/tests/kolmogorov_smirnov_test.m, scripts/statistics/tests/kolmogorov_smirnov_test_2.m, scripts/statistics/tests/kruskal_wallis_test.m, scripts/statistics/tests/prop_test_2.m, scripts/statistics/tests/sign_test.m, scripts/statistics/tests/t_test.m, scripts/statistics/tests/t_test_2.m, scripts/statistics/tests/t_test_regression.m, scripts/statistics/tests/u_test.m, scripts/statistics/tests/var_test.m, scripts/statistics/tests/welch_test.m, scripts/statistics/tests/wilcoxon_test.m, scripts/statistics/tests/z_test.m, scripts/statistics/tests/z_test_2.m, scripts/strings/base2dec.m, scripts/strings/index.m, scripts/strings/isstrprop.m, scripts/strings/mat2str.m, scripts/strings/regexptranslate.m, scripts/strings/rindex.m, scripts/strings/str2num.m, scripts/strings/strcat.m, scripts/strings/strjust.m, scripts/strings/strmatch.m, scripts/strings/validatestring.m, scripts/testfun/demo.m, scripts/testfun/example.m, scripts/testfun/test.m, scripts/time/addtodate.m, scripts/time/asctime.m, scripts/time/datestr.m, scripts/time/datetick.m, scripts/time/weekday.m, scripts/ui/errordlg.m, scripts/ui/helpdlg.m, scripts/ui/inputdlg.m, scripts/ui/listdlg.m, scripts/ui/msgbox.m, scripts/ui/questdlg.m, scripts/ui/warndlg.m: Use new @qcode macro.
author Rik <rik@octave.org>
date Mon, 19 Aug 2013 20:46:38 -0700
parents 9ba57ed05207
children d63878346099
comparison
equal deleted inserted replaced
17280:1a5407bae739 17281:bc924baa2c4e
652 Query or set the internal variable that controls whether Octave sends\n\ 652 Query or set the internal variable that controls whether Octave sends\n\
653 output to the pager as soon as it is available. Otherwise, Octave\n\ 653 output to the pager as soon as it is available. Otherwise, Octave\n\
654 buffers its output and waits until just before the prompt is printed to\n\ 654 buffers its output and waits until just before the prompt is printed to\n\
655 flush it to the pager.\n\ 655 flush it to the pager.\n\
656 \n\ 656 \n\
657 When called from inside a function with the \"local\" option, the variable is\n\ 657 When called from inside a function with the @qcode{\"local\"} option, the\n\
658 changed locally for the function and any subroutines it calls. The original\n\ 658 variable is changed locally for the function and any subroutines it calls. \n\
659 variable value is restored when exiting the function.\n\ 659 The original variable value is restored when exiting the function.\n\
660 @seealso{page_screen_output, more, PAGER, PAGER_FLAGS}\n\ 660 @seealso{page_screen_output, more, PAGER, PAGER_FLAGS}\n\
661 @end deftypefn") 661 @end deftypefn")
662 { 662 {
663 return SET_INTERNAL_VARIABLE (page_output_immediately); 663 return SET_INTERNAL_VARIABLE (page_output_immediately);
664 } 664 }
672 for the terminal window that is longer than one page is sent through a\n\ 672 for the terminal window that is longer than one page is sent through a\n\
673 pager. This allows you to view one screenful at a time. Some pagers\n\ 673 pager. This allows you to view one screenful at a time. Some pagers\n\
674 (such as @code{less}---see @ref{Installation}) are also capable of moving\n\ 674 (such as @code{less}---see @ref{Installation}) are also capable of moving\n\
675 backward on the output.\n\ 675 backward on the output.\n\
676 \n\ 676 \n\
677 When called from inside a function with the \"local\" option, the variable is\n\ 677 When called from inside a function with the @qcode{\"local\"} option, the\n\
678 changed locally for the function and any subroutines it calls. The original\n\ 678 variable is changed locally for the function and any subroutines it calls. \n\
679 variable value is restored when exiting the function.\n\ 679 The original variable value is restored when exiting the function.\n\
680 @seealso{more, page_output_immediately, PAGER, PAGER_FLAGS}\n\ 680 @seealso{more, page_output_immediately, PAGER, PAGER_FLAGS}\n\
681 @end deftypefn") 681 @end deftypefn")
682 { 682 {
683 return SET_INTERNAL_VARIABLE (page_screen_output); 683 return SET_INTERNAL_VARIABLE (page_screen_output);
684 } 684 }
688 @deftypefn {Built-in Function} {@var{val} =} PAGER ()\n\ 688 @deftypefn {Built-in Function} {@var{val} =} PAGER ()\n\
689 @deftypefnx {Built-in Function} {@var{old_val} =} PAGER (@var{new_val})\n\ 689 @deftypefnx {Built-in Function} {@var{old_val} =} PAGER (@var{new_val})\n\
690 @deftypefnx {Built-in Function} {} PAGER (@var{new_val}, \"local\")\n\ 690 @deftypefnx {Built-in Function} {} PAGER (@var{new_val}, \"local\")\n\
691 Query or set the internal variable that specifies the program to use\n\ 691 Query or set the internal variable that specifies the program to use\n\
692 to display terminal output on your system. The default value is\n\ 692 to display terminal output on your system. The default value is\n\
693 normally @code{\"less\"}, @code{\"more\"}, or\n\ 693 normally @qcode{\"less\"}, @qcode{\"more\"}, or\n\
694 @code{\"pg\"}, depending on what programs are installed on your system.\n\ 694 @qcode{\"pg\"}, depending on what programs are installed on your system.\n\
695 @xref{Installation}.\n\ 695 @xref{Installation}.\n\
696 \n\ 696 \n\
697 When called from inside a function with the \"local\" option, the variable is\n\ 697 When called from inside a function with the @qcode{\"local\"} option, the\n\
698 changed locally for the function and any subroutines it calls. The original\n\ 698 variable is changed locally for the function and any subroutines it calls. \n\
699 variable value is restored when exiting the function.\n\ 699 The original variable value is restored when exiting the function.\n\
700 @seealso{PAGER_FLAGS, page_output_immediately, more, page_screen_output}\n\ 700 @seealso{PAGER_FLAGS, page_output_immediately, more, page_screen_output}\n\
701 @end deftypefn") 701 @end deftypefn")
702 { 702 {
703 return SET_NONEMPTY_INTERNAL_STRING_VARIABLE (PAGER); 703 return SET_NONEMPTY_INTERNAL_STRING_VARIABLE (PAGER);
704 } 704 }
709 @deftypefnx {Built-in Function} {@var{old_val} =} PAGER_FLAGS (@var{new_val})\n\ 709 @deftypefnx {Built-in Function} {@var{old_val} =} PAGER_FLAGS (@var{new_val})\n\
710 @deftypefnx {Built-in Function} {} PAGER_FLAGS (@var{new_val}, \"local\")\n\ 710 @deftypefnx {Built-in Function} {} PAGER_FLAGS (@var{new_val}, \"local\")\n\
711 Query or set the internal variable that specifies the options to pass\n\ 711 Query or set the internal variable that specifies the options to pass\n\
712 to the pager.\n\ 712 to the pager.\n\
713 \n\ 713 \n\
714 When called from inside a function with the \"local\" option, the variable is\n\ 714 When called from inside a function with the @qcode{\"local\"} option, the\n\
715 changed locally for the function and any subroutines it calls. The original\n\ 715 variable is changed locally for the function and any subroutines it calls. \n\
716 variable value is restored when exiting the function.\n\ 716 The original variable value is restored when exiting the function.\n\
717 @seealso{PAGER, more, page_screen_output, page_output_immediately}\n\ 717 @seealso{PAGER, more, page_screen_output, page_output_immediately}\n\
718 @end deftypefn") 718 @end deftypefn")
719 { 719 {
720 return SET_NONEMPTY_INTERNAL_STRING_VARIABLE (PAGER_FLAGS); 720 return SET_NONEMPTY_INTERNAL_STRING_VARIABLE (PAGER_FLAGS);
721 } 721 }