Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Commandline help text not correct (e.g., "-f,--fetch <FILE>" does not use a file) #2016

Closed
baderas opened this issue Sep 20, 2016 · 9 comments
Labels
cli good first issue An issue intended for project-newcomers. Varies in difficulty. type: documentation

Comments

@baderas
Copy link

baderas commented Sep 20, 2016

JabRef version 3.5 Windows 10 x64

Steps to reproduce:

  1. java -jar JabRef-3.5.jar -h
  2. Look at output

See http://help.jabref.org/en/CommandLine

<FILE> is always used as argument name. This is wrong for some command line items, for example -f,--fetch <FILE> is used as "--fetch=Medline:cancer". The correct help entry would be -f, --fetch <SearchTerm> with an explanation how <SearchTerm> must be used.
For some arguments a filename and some additional information (separated by comma, e.g., for -i) can be given. <FILE> is also not correct there.

Same problem exists for:

-d,--prdef <FILE>
 -i,--import <FILE>
    --importToOpen <FILE> 
-m,--exportMatches <FILE> 
-o,--output <FILE> 
@lenhard
Copy link
Member

lenhard commented Sep 20, 2016

Let me add that fetching alone will not do much. It will fetch, but the results will cease to exist when the invocation terminates. To get actual output, the fetch command should be chained with -o.

Having said that, the documentation can certainly be improved. @baderas: Could you provide a pull request? Improving the textual output of the command line is certainly a good entry point.

@koppor
Copy link
Member

koppor commented Sep 20, 2016

We think that the command line should be --fetch=Medline:cancer test.bib

@lenhard
Copy link
Member

lenhard commented Sep 23, 2016

I just noticed that this issue is in a sense a duplicate of #1850. I am closing the older one and we can track further discussion here.

@koppor koppor added good first issue An issue intended for project-newcomers. Varies in difficulty. and removed PE1718 labels Mar 9, 2018
@dhananjaya2007
Copy link

If no one is working on this issue, may I fix it? Thanks

@Siedlerchr
Copy link
Member

@dhananjaya2007 Sure go ahead

@davidemdot
Copy link
Member

What do you think about this output?

Screenshot_20190513_031750

@davidemdot
Copy link
Member

The point is that Apache Commons (library currently used) prints the argument(s) within the symbols "<" and ">". So, if we want to show the CLI help like above, it would be easy. In another case, I can program a new code for this.

@tobiasdiez
Copy link
Member

@davidemdot Looks good to me. The argument to prdef should be KEY and -m needs a better description. Moreover, I like the example given for -fetch in the description. For me this is easier to understand than e.g. the format for import or aux.

@Siedlerchr
Copy link
Member

Thanks to @davidemdot this issue is now fixed in the lastest master.

We would like to ask you to use a development build from https://builds.jabref.org/master and report back if it works for you. Please remember to make a backup of your library before trying-out this version.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cli good first issue An issue intended for project-newcomers. Varies in difficulty. type: documentation
Projects
None yet
Development

No branches or pull requests

7 participants