Fossil

Check-in [a5cd7927]
Login

Many hyperlinks are disabled.
Use anonymous login to enable hyperlinks.

Overview
Comment:link the command line help to the gui pages, where appropriate
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | wolfgangHelpCmd
Files: files | file ages | folders
SHA1: a5cd79272f1287b8aa96f170945ac0b1bbfb86b1
User & Date: wolfgang 2010-10-09 15:34:14
Context
2010-10-09
15:39
merge from trunk check-in: e1d15514 user: wolfgang tags: wolfgangHelpCmd
15:34
link the command line help to the gui pages, where appropriate check-in: a5cd7927 user: wolfgang tags: wolfgangHelpCmd
13:33
added a gui diff form to enter the UUIDs, branches, .. and add a link to info page check-in: cee3e081 user: wolfgang tags: wolfgangHelpCmd
Changes
Hide Diffs Side-by-Side Diffs Ignore Whitespace Patch

Changes to src/db.c.

  1602   1602   **    ssh-command   Command used to talk to a remote machine with
  1603   1603   **                  the "ssh://" protocol.
  1604   1604   **
  1605   1605   **    web-browser   A shell command used to launch your preferred
  1606   1606   **                  web browser when given a URL as an argument.
  1607   1607   **                  Defaults to "start" on windows, "open" on Mac,
  1608   1608   **                  and "firefox" on Unix.
         1609  +**
         1610  +** There is a simple form in the administration gui for these settings:
         1611  +**  *  Go to the <a href="setup">Admin</a> page
         1612  +**  ** and click <a href="setup_settings">Settings</a>
  1609   1613   */
  1610   1614   void setting_cmd(void){
  1611   1615     int i;
  1612   1616     int globalFlag = find_option("global","g",0)!=0;
  1613   1617     int unsetFlag = g.argv[1][0]=='u';
  1614   1618     db_open_config(1);
  1615   1619     db_find_and_open_repository(0);

Changes to src/descendants.c.

   253    253       timeline_query_for_tty()
   254    254     );
   255    255     print_timeline(&q, 20);
   256    256     db_finalize(&q);
   257    257   }
   258    258   
   259    259   /*
   260         -** COMMAND:  leaves
          260  +** COMMAND: leaves
   261    261   **
   262    262   ** Usage: %fossil leaves ?--all? ?--closed?
   263    263   **
   264    264   ** Find leaves of all branches.  By default show only open leaves.
   265    265   ** The --all flag causes all leaves (closed and open) to be shown.
   266    266   ** The --closed flag shows only closed leaves.
          267  +**
          268  +** This information can also be viewed in the gui:
          269  +**  * Go the <a href="leaves">leaves</a> page
   267    270   */
   268    271   void leaves_cmd(void){
   269    272     Stmt q;
   270    273     int showAll = find_option("all", 0, 0)!=0;
   271    274     int showClosed = find_option("closed", 0, 0)!=0;
   272    275   
   273    276     db_must_be_within_tree();

Changes to src/diff.c.

   823    823   /*
   824    824   ** COMMAND: annotate
   825    825   **
   826    826   ** %fossil annotate FILENAME
   827    827   **
   828    828   ** Output the text of a file with markings to show when each line of
   829    829   ** the file was last modified.
          830  +**
          831  +** This can also be viewed in the gui, if you click the "annotate" link
          832  +** on the "File History" page of files.
   830    833   */
   831    834   void annotate_cmd(void){
   832    835     int fnid;         /* Filename ID */
   833    836     int fid;          /* File instance ID */
   834    837     int mid;          /* Manifest where file was checked in */
   835    838     Blob treename;    /* FILENAME translated to canonical form */
   836    839     char *zFilename;  /* Cannonical filename */

Changes to src/diffcmd.c.

   365    365   ** check-out are used.
   366    366   **
   367    367   ** The "-i" command-line option forces the use of the internal diff logic
   368    368   ** rather than any external diff program that might be configured using
   369    369   ** the <a>setting</a> command. If no external diff program is configured, then
   370    370   ** the "-i" option is a no-op.  The "-i" option converts "gdiff" into
   371    371   ** "diff".
          372  +**
          373  +** The results of the internal diff command can also be seen in the gui:
          374  +**  1. Go to the <a href="vdiff">vdiff</a> page
          375  +**  2. use the "diff against another version" link on the Check-in detail view.
   372    376   */
   373    377   void diff_cmd(void){
   374    378     int isGDiff;               /* True for gdiff.  False for normal diff */
   375    379     int isInternDiff;          /* True for internal diff */
   376    380     const char *zFrom;         /* Source version number */
   377    381     const char *zTo;           /* Target version number */
   378    382     const char *zDiffCmd = 0;  /* External diff command. NULL for internal diff */

Changes to src/finfo.c.

    25     25   ** 
    26     26   ** Usage: %fossil finfo FILENAME
    27     27   **
    28     28   ** Print the change history for a single file.
    29     29   **
    30     30   ** The "--limit N" and "--offset P" options limit the output to the first
    31     31   ** N changes after skipping P changes.
           32  +**
           33  +** The history of a file can also be viewed in the gui:
           34  +**  * Go to the <a href="dir">file browser</a> and drill down to the file
    32     35   */
    33     36   void finfo_cmd(void){
    34     37     Stmt q;
    35     38     int vid;
    36     39     Blob dest;
    37     40     const char *zFilename;
    38     41     const char *zLimit;

Changes to src/main.c.

   556    556   
   557    557   
   558    558   /*
   559    559   ** COMMAND: help
   560    560   **
   561    561   ** Usage: %fossil help COMMAND
   562    562   **
   563         -** Display information on how to use COMMAND
          563  +** Display information on how to use COMMAND. If COMMAND is
          564  +** omitted, a list of available commands is displayed.
          565  +**
          566  +** This can also be viewed in the gui:
          567  +**  * Go to the <a href="help">help</a> page and click COMMAND
   564    568   */
   565    569   void help_cmd(void){
   566    570     int rc, idx;
   567    571     const char *z;
   568    572     if( g.argc!=3 ){
   569    573       printf("Usage: %s help COMMAND.\nAvailable COMMANDs:\n", g.argv[0]);
   570    574       cmd_cmd_list();
................................................................................
   582    586       fossil_fatal("no help available for the %s command",
   583    587          aCommand[idx].zName);
   584    588     }
   585    589     while( *z ){
   586    590       if( *z=='%' && strncmp(z, "%fossil", 7)==0 ){
   587    591         printf("%s", g.argv[0]);
   588    592         z += 7;
          593  +    }else if( *z=='<' && strncmp(z,"<a ",3)==0 ){
          594  +      putchar('"');
          595  +      while( *z && *z!='>') z++;
          596  +      if( *z ) z++;
   589    597       }else if( *z=='<' && strncmp(z,"<a>",3)==0 ){
   590    598         putchar('"');
   591    599         z += 3;
   592    600       }else if( *z=='<' && strncmp(z,"</a>",4)==0 ){
   593    601         putchar('"');
   594    602         z += 4;
   595    603       }else{
................................................................................
   633    641               }else if( zSrc[src]=='<' && strncmp(zSrc+src, "</a>", 3)==0 ){
   634    642                 src += 4;
   635    643                 zDest[dest++]='<';
   636    644                 zDest[dest++]='/';
   637    645                 zDest[dest++]='a';
   638    646                 zDest[dest++]='>';
   639    647                 zDest[dest++]='"';
          648  +            }else if( zSrc[src]=='<' && strncmp(zSrc+src, "<a ", 3)==0 ){
          649  +              len += 2;
          650  +	      zDest=realloc(zDest,len);
          651  +              zDest[dest++]='"';
          652  +              while( zSrc[src] && zSrc[src]!='>' ){
          653  +                zDest[dest++]=zSrc[src++];
          654  +              }
          655  +              if( zSrc[src] ) zDest[dest++]=zSrc[src++];
   640    656               }else if( zSrc[src]=='<' && strncmp(zSrc+src, "<a>", 3)==0 ){
   641    657                 /* found an internal command cross reference,
   642    658                 ** create an additional link
   643    659                 */
   644    660                 int start;
   645    661   
   646    662                 len+=80;
................................................................................
   924    940   **
   925    941   **      #!/usr/bin/fossil
   926    942   **      repository: /home/somebody/project.db
   927    943   **
   928    944   ** The second line defines the name of the repository.  After locating
   929    945   ** the repository, fossil will generate a webpage on stdout based on
   930    946   ** the values of standard CGI environment variables.
          947  +**
          948  +** See also the <a>http</a>, <a>server</a> and <a>ui</a> commands.
   931    949   */
   932    950   void cmd_cgi(void){
   933    951     const char *zFile;
   934    952     const char *zNotFound = 0;
   935    953     Blob config, line, key, value;
   936    954     if( g.argc==3 && strcmp(g.argv[1],"cgi")==0 ){
   937    955       zFile = g.argv[2];
................................................................................
  1037   1055   ** repository.
  1038   1056   **
  1039   1057   ** If REPOSITORY is a directory that contains one or more respositories
  1040   1058   ** with names of the form "*.fossil" then the first element of the URL
  1041   1059   ** pathname selects among the various repositories.  If the pathname does
  1042   1060   ** not select a valid repository and the --notfound option is available,
  1043   1061   ** then the server redirects (HTTP code 302) to the URL of --notfound.
         1062  +**
         1063  +** See also the <a>cgi</a>, <a>server</a> and <a>ui</a> commands.
  1044   1064   */
  1045   1065   void cmd_http(void){
  1046   1066     const char *zIpAddr;
  1047   1067     const char *zNotFound;
  1048   1068     zNotFound = find_option("notfound", 0, 1);
  1049   1069     g.cgiOutput = 1;
  1050   1070     if( g.argc!=2 && g.argc!=3 && g.argc!=6 ){
................................................................................
  1125   1145   ** the web server.  The "ui" command also binds to 127.0.0.1 and so will
  1126   1146   ** only process HTTP traffic from the local machine.
  1127   1147   **
  1128   1148   ** In the "server" command, the REPOSITORY can be a directory (aka folder)
  1129   1149   ** that contains one or more respositories with names ending in ".fossil".
  1130   1150   ** In that case, the first element of the URL is used to select among the
  1131   1151   ** various repositories.
         1152  +**
         1153  +** See also the <a>cgi</a> and <a>http</a> commands.
  1132   1154   */
  1133   1155   void cmd_webserver(void){
  1134   1156     int iPort, mxPort;        /* Range of TCP ports allowed */
  1135   1157     const char *zPort;        /* Value of the --port option */
  1136   1158     char *zBrowser;           /* Name of web browser program */
  1137   1159     char *zBrowserCmd = 0;    /* Command to launch the web browser */
  1138   1160     int isUiCmd;              /* True if command is "ui", not "server' */

Changes to src/rebuild.c.

   483    483   ** Usage: %fossil reconstruct FILENAME DIRECTORY
   484    484   **
   485    485   ** This command studies the artifacts (files) in DIRECTORY and
   486    486   ** reconstructs the fossil record from them. It places the new
   487    487   ** fossil repository in FILENAME. Subdirectories are read, files
   488    488   ** with leading '.' in the filename are ignored.
   489    489   **
          490  +** See also the <a>deconstruct</a> command.
   490    491   */
   491    492   void reconstruct_cmd(void) {
   492    493     char *zPassword;
   493    494     if( g.argc!=4 ){
   494    495       usage("FILENAME DIRECTORY");
   495    496     }
   496    497     if( file_isdir(g.argv[3])!=1 ){
................................................................................
   531    532   ** This command exports all artifacts of o given repository and writes
   532    533   ** all artifacts to the file system. The DESTINATION directory will be
   533    534   ** populated with subdirectories AA and files AA/BBBBBBBBB.., where
   534    535   ** AABBBBBBBBB.. is the 40 character artifact ID and AA the first 2
   535    536   ** characters.
   536    537   ** If -L|--prefixlength is given, the length (default 2) of the directory
   537    538   ** prefix can be set to 0,1,..,9 characters.
          539  +**
          540  +** See also the <a>reconstruct</a> command.
   538    541   */
   539    542   void deconstruct_cmd(void){
   540    543     const char *zDestDir;
   541    544     const char *zPrefixOpt;
   542    545     Stmt        s;
   543    546   
   544    547     /* check number of arguments */

Changes to src/timeline.c.

  1090   1090   ** The optional TYPE argument may any types supported by the /timeline
  1091   1091   ** page. For example:
  1092   1092   **
  1093   1093   **     w  = wiki commits only
  1094   1094   **     ci = file commits only
  1095   1095   **     t  = tickets only
  1096   1096   **     e  = events only
         1097  +**
         1098  +** The information can also be used in the gui:
         1099  +**  * go to the <a href="timeline">timeline</a> page
  1097   1100   */
  1098   1101   void timeline_cmd(void){
  1099   1102     Stmt q;
  1100   1103     int n, k;
  1101   1104     const char *zCount;
  1102   1105     const char *zType;
  1103   1106     char *zOrigin;

Changes to src/tkt.c.

   890    890   **
   891    891   **     %fossil ticket add FIELD VALUE ?FIELD VALUE .. ? ?-q|--quote?
   892    892   **
   893    893   **         like set, but create a new ticket with the given values.
   894    894   **
   895    895   ** The values in set|add are not validated against the definitions
   896    896   ** given in "Ticket Common Script".
          897  +**
          898  +** All this stuff can also be done in the gui:
          899  +**  * Go the the <a href="reportlist">Tickets</a> page
   897    900   */
   898    901   void ticket_cmd(void){
   899    902     int n;
   900    903   
   901    904     /* do some ints, we want to be inside a checkout */
   902    905     db_must_be_within_tree();
   903    906     db_find_and_open_repository(1);

Changes to src/zip.c.

   379    379   ** Usage: %fossil zip VERSION OUTPUTFILE [--name DIRECTORYNAME]
   380    380   **
   381    381   ** Generate a ZIP archive for a specified version.  If the --name option
   382    382   ** is used, it argument becomes the name of the top-level directory in the
   383    383   ** resulting ZIP archive.  If --name is omitted, the top-level directory
   384    384   ** named is derived from the project name, the check-in date and time, and
   385    385   ** the artifact ID of the check-in.
          386  +**
          387  +** The zip download can also be done through the Check-in detail view,
          388  +** accessible from the <a href="timeline">timeline</a> page.
   386    389   */
   387    390   void baseline_zip_cmd(void){
   388    391     int rid;
   389    392     Blob zip;
   390    393     const char *zName;
   391    394     zName = find_option("name", 0, 1);
   392    395     db_find_and_open_repository(1);