Changes between Version 1 and Version 2 of ErlangShellInterface


Ignore:
Timestamp:
Mar 7, 2012, 12:39:47 AM (13 years ago)
Author:
manualwiki
Comment:

finished ri page

Legend:

Unmodified
Added
Removed
Modified

  • ErlangShellInterface

    v1 v2  
    11 
    2 == RefactorErl Console Interface == 
    3 After start up you can use the ri module to interact easily with the tool. With this you can add files/directories to the database, run semantic queries, create backups, or even do transformations. 
     2== !RefactorErl Console Interface == 
     3After start up you can use the ri module to interact easily with the tool. With this you can add files/directories to the database, run semantic queries, create backups, or even do transformations, etc. 
    44 
    55 
    … …  
    5353 
    5454== Managing files == 
    55 You can add files to the RefactorErl database by calling the 
     55You can add files to the !RefactorErl database by calling the 
    5656add function with either a filename as a string or a module name as an atom. 
    5757Note that in the latter case, "ri" defaults to the current working directory 
    … …  
    153153 
    154154Loading BEAM files. Usually, Erlang source files (having the extension 
    155 .erl) are loaded into RefactorErl. In addition, RefactorErl is also capable of 
     155.erl) are loaded into !RefactorErl. In addition, !RefactorErl is also capable of 
    156156loading compiled .beam files. 
    157157 
    … …  
    162162Note that this feature is applicable only to those .beam files that were compiled 
    163163with the debug_info option. Also note that the resulting file will be pretty 
    164 printed by RefactorErl. 
     164printed by !RefactorErl. 
    165165 
    166166== Using transformations == 
    … …  
    176176 
    177177== Manipulating the graph == 
    178 You can reset RefactorErl by invoking 
     178You can reset the database by invoking 
    179179 
    180180{{{ 
    … …  
    204204 
    205205== Inspecting the graph == 
    206 You can draw the semantic representation graph of RefactorErl by calling 
     206You can draw the semantic representation graph of !RefactorErl by calling 
    207207 
    208208{{{ 
    … …  
    212212This function produces a .dot file (by default, graph.dot, although this can be 
    213213customised), which can be transformed to several visual formats using Graphviz. 
    214 One of these transformations is available from RefactorErl for convenience: 
     214One of these transformations is available from !RefactorErl for convenience: 
    215215 
    216216{{{ 
    … …  
    224224}}} 
    225225 
    226 where Filter is one of the following:[[BR]] 
    227  all: default, all edges except environmental ones are shown 
    228  syn: only syntactic edges are shown 
    229  sem: only semantic edges are shown 
    230  lex: only lexical edges are shown 
    231  all_env: all edges are shown, no ltering 
    232  ctx: context related edges are shown 
    233  not_lex: all edges except lexical ones are shown 
    234  dataflow: dataflow related edges are shown 
    235  a list of the above: shows the union of the designated subgraphs 
     226where Filter is one of the following:\\ 
     227* '''all''': default, all edges except environmental ones are shown.\\ 
     228* '''syn''': only syntactic edges are shown.\\ 
     229* '''sem''': only semantic edges are shown.\\ 
     230* '''lex''': only lexical edges are shown.\\ 
     231* '''all_env''': all edges are shown, no filtering.\\ 
     232* '''ctx''': context related edges are shown.\\ 
     233* '''not_lex''': all edges except lexical ones are shown.\\ 
     234* '''dataflow''': dataflow related edges are shown.\\ 
     235* '''a list of the above''': shows the union of the designated subgraphs.\\ 
    236236 
    237237== Using queries == 
    … …  
    258258cannot mark a position, the first and the second component indicate the starting 
    259259point for the query. The following example shows how to get all the variables 
    260 used in the body of the function f/2 from the module m. 
     260used in the body of the function '''f/2''' from the module '''m'''. 
    261261 
    262262{{{ 
    … …  
    265265 
    266266Additional options can be given to a semantic query in a proplist as the last 
    267 argument. The following arguments are currently recognized: 
    268  {out,FileName} - write the textual output of a query to a file 
    269  linenum - prepends match sites with le and line number information 
    270 similar to grep -n. 
    271 The following example outputs all dened functions with line numbers to a 
     267argument. The following arguments are currently recognized:\\ 
     268* '''{out,!FileName}''': write the textual output of a query to a file.\\ 
     269* '''linenum''': prepends match sites with le and line number information.\\ 
     270similar to '''grep -n'''. 
     271The following example outputs all defined functions with line numbers to a 
    272272file named result.txt. 
    273273 
    … …  
    275275ri:q("mods.funs",[linenum,{out,"result.txt"}]). 
    276276}}} 
     277 
     278 
     279== Server management command list == 
     280 
     281Here's the list of supported server management commands:\\ 
     282* '''add(FDML)''': add a module, file, directory or a list of these to the database. \\ 
     283* '''drop(FDML)''': drop a module from the database. \\ 
     284* '''ls()''': list files that are in the database. \\ 
     285* '''backup()''': update the backup (checkpoint). \\ 
     286* '''undo()''': undo the transformation (rollback, only one step). \\ 
     287* '''clean()''': clean backups (delete all checkpoints). \\ 
     288* '''reset()''': reset the database to an empty state, but valid schema. \\ 
     289* '''graph(Target)''': assume no options and call one of the next two. \\ 
     290* '''graph(Atom,Options)''': assume ".dot" extension and call the one below. \\ 
     291* '''graph(File,Options)''': draw the graph with the given options. \\ 
     292* '''svg()''': draw the graph to graph.svg and call Graphviz. \\ 
     293* '''svg(File)''' \\ 
     294* '''svg(File, Options)''' \\ 
     295The additional/modied commands, that you can use, if you use the NIF 
     296database engine:\\ 
     297* '''backup()''': creates a backup. \\ 
     298* '''backup(!CommitLog)''': creates a backup as '''ri:backup/0''', but here the user can attach a commit log to the backup file. \\ 
     299* '''ls_backups()''': returns a lists of backups, that has been created before with '''ri:backup/0''' or '''ri:backup/1'''. \\ 
     300* '''backup_info(Backup)''': returns information about the given backup. \\ 
     301* '''restore(Backup)''': restores the given backup. \\ 
     302* '''create_graph(Name)''': creates a graph with the given name. \\ 
     303* '''rename_graph(!OldName, !NewName)''': renames a graph that has the given !OldName, with the given !NewName. \\ 
     304* '''ls_graphs()''': returns a list of the created graphs. \\ 
     305* '''actual_graph()''': returns the actual graph's name. \\ 
     306* '''load_graph(Name)''': loads the given graph. \\ 
     307* '''delete_graph(Name)''': removes the given graph. \\ 
     308* '''delete_all_graphs()''': removes all graphs. \\