Scilab Home Page | Wiki | Bug Tracker | Forge | Mailing List Archives | Scilab Online Help | File Exchange
ATOMS : uman - User manual in console + advanced features details
Login with GitLab

uman - User manual in console + advanced features

User manual in console + Advanced documentation features
(3356 downloads for this version - 64781 downloads for all versions)
Details
Version
3.2
Author
Samuel GOUGEON
Owner Organization
private individual
Maintainers
Samuel GOUGEON
Samuel Gougeon
Category
License
Creation Date
March 28, 2023
Source created on
Scilab 2023.0.x
Binaries available on
Scilab 6.0.x:
Windows 64-bit Windows 32-bit Linux 64-bit Linux 32-bit macOS
Scilab 6.1.x:
Windows 64-bit Windows 32-bit Linux 64-bit Linux 32-bit macOS
Scilab 2023.0.x:
Windows 64-bit Windows 32-bit Linux 64-bit Linux 32-bit macOS
Install command
--> atomsInstall("uman")
Description
            uman() lets you to ..
 - display Scilab and ATOMS help pages in the console
 - choose the only help section(s) you want to display:
   syntaxes, parameters, description, examples, history,
   or the summary of the item's section..
 - display the page on the web, or in the help browser
 - display heading comments of user's defined functions
 - select and list bugs related to the item
 - select and display related messages posted on Scilab
   mailing lists

CHANGES : https://atoms.scilab.org/toolboxes/uman/3.2/files/changelog.txt

USER MANUAL (PDF)
-----------------
English : https://atoms.scilab.org/toolboxes/uman/3.2/files/uman_3.2_en.pdf
Français: https://atoms.scilab.org/toolboxes/uman/3.2/files/uman_3.2_fr.pdf

COMMENTS & BUG REPORTS: https://atoms.scilab.org/toolboxes/uman


SYNTAXES
--------
 uman       — User manual in console, online, or help browser, with
               language switch and related bugs & messages.
 uman .. g  — Displays the item's documentation in the help browser.
 uman .. @  — Selects informations from Scilab mailing lists.
 uman .. w  — Shows the online help page or the reference web page
               of an item.
 uman .. b  — Shows bugs reported on Scilab bugzilla or forge bugs
              trackers, or as ATOMS comments
 disp_usage — Displays allowed syntaxes to call a given function.


MAIN FEATURES
-------------
uman() allows to easily select, grab and display information
 * from embedded Scilab help pages,
 * from pages of installed ATOMS modules,
 * from heading comments in local user-defined functions,
 * from pages of other external modules, packed in .jar archives,
 * from pages of former REMOVED Scilab functions,
 * from the online Scilab help pages and search engine,
 * from ATOMS web pages and their comments,
 * from online Scilab forges,
 * from Scilab FileExchange pages,
 * from Scilab's bugs tracker,
 * from archives of users@ and dev@ Scilab mailing lists,
 * and from other external web sites presenting Scilab resources.

Do not care where the required information is: uman gets it from the right place
and displays it for you: In the console, in the help browser, or in your
internet browser for online resources: just provide the right 1-char option in
the command line.

The default factory settings of uman do not match your most frequent needs? uman
has a comprehensive set of configuration parameters, easy to set in the uman
Preferences interface. You will always be able to easily override them with
compact command-line options.

No need to view the whole help page. Just choose information that you want to
display: only usages (syntaxes) and See also. Or more: parameters, description,
examples, history, table of contents of the item's help section.. If really
the whole page must be displayed, the "a" option will do it.

You use to code in Octave language? Specify the Octave term you have in mind :
More than 220 automatic redirections will target and display the closest Scilab
equivalences. Other handy shortcuts are also defined for all users.

Just give a language code en | de | fr | ja | pt | ru | zh in option, and you
get the right version of the help page in the console or online. No need to
change the session language. Watching the reference en_US english version of the
page is now straightforward, without leaving your locales.

The item of your query is a deprecated feature that has been removed from
Scilab? uman will tell it to you, and may anyway display its former help page,
online, or in the console or the help browser (provided that the https://atoms.scilab.org/toolboxes/removed
complementary module gathering pages of removed features is installed).

You think that you met a bug? Check it with the "b" option, that will
nicely list online documented bugs related to your query, possibly with filters
(reporter's name, category, max age of last reports update), for Scilab and
many ATOMS packages. Online users comments are as well directly reachable..

No need to load modules in the Scilab session. Even the documentation of
packages that do not run under your Operating System can be viewed and displayed
in the console.

Want to efficiently probe mailing lists, for some items, or some authors, on
some given period? "uman .. @" does it easily for you from the
console.

            
Files (7)
[35.36 kB]
Miscellaneous file

[307.00 kB]
Source code archive

[1.48 MB]
OS-independent binary for Scilab 2023.0.x

[1.48 MB]
OS-independent binary for Scilab 6.0.x

[1.48 MB]
OS-independent binary for Scilab 6.1.x

[518.23 kB]
Miscellaneous file
User manual (english)
[566.64 kB]
Miscellaneous file
Manuel d'utilisation (français)
News (0)
Comments (1)     Leave a comment 
Comment from pierre perrichon -- October 29, 2023, 04:31:09 PM    
With W11 Scilab 2024.0.0, simple instruction

uman

scratches Scilab
It seems correct with Scilab 2023.x.y
Leave a comment
You must register and log in before leaving a comment.
Login with GitLab
Email notifications
Send me email when this toolbox has changes, new files or a new release.
You must register and log in before setting up notifications.