[ 
https://issues.apache.org/jira/browse/PDFBOX-2602?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17255604#comment-17255604
 ] 

Maruan Sahyoun edited comment on PDFBOX-2602 at 12/28/20, 2:31 PM:
-------------------------------------------------------------------

{noformat}
Usage: pdfbox [COMMAND] [OPTIONS]
Commands:
  debug          Analyzes and inspects the internal structure of a PDF document
  decrypt        Decrypts a PDF document
  encrypt        Encrypts a PDF document
  exportfdf      Exports AcroForm form data to FDF
  exportxfdf     Exports AcroForm form data to XFDF
  importfdf      Imports AcroForm form data from FDF
  importxfdf     Imports AcroForm form data from XFDF
  extractimages  Extracts the images from a PDF document
  extracttext    Extracts the text from a PDF document
  overlay        Adds an overlay to a PDF document
  print          Prints a PDF document
  split          Splits a PDF document into number of new documents
  fromimage      Creates a PDF document from images
  fromtext       Creates a PDF document from text
  decode         Writes a PDF document with all streams decoded
  version        Gets the version of PDFBox
  help           Displays help information about the specified command
{noformat}

I've kept the original names of the individual tools but use them under a 
different command in the pdfbox app so it's more consistent and looks like an 
action to be executed - WDYT? Not committed yet!


was (Author: msahyoun):
{noformat}
Usage: pdfbox [COMMAND] [OPTIONS]
Commands:
  debug          Analyzes and inspects the internal structure of a PDF document
  decrypt        Decrypts a PDF document
  encrypt        Encrypts a PDF document
  exportfdf      Exports AcroForm form data to FDF
  exportxfdf     Exports AcroForm form data to XFDF
  importfdf      Imports AcroForm form data from FDF
  importxfdf     Imports AcroForm form data from XFDF
  extractimages  Extracts the images from a PDF document
  extracttext    Extracts the text from a PDF document
  overlay        Adds an overlay to a PDF document
  print          Prints a PDF document
  split          Splits a PDF document into number of new documents
  fromimage      Creates a PDF document from images
  fromtext       Creates a PDF document from text
  decode         Writes a PDF document with all streams decoded
  version        Gets the version of PDFBox
  help           Displays help information about the specified command
{noformat}

I've kept the original names of the individual tools but use them under a 
different command in the pdfbox app so it's more consistent and looks like an 
action to be executed - WDYT?

> Enhance command line tools
> --------------------------
>
>                 Key: PDFBOX-2602
>                 URL: https://issues.apache.org/jira/browse/PDFBOX-2602
>             Project: PDFBox
>          Issue Type: Bug
>          Components: Utilities
>    Affects Versions: 1.8.8, 2.0.0
>            Reporter: Maruan Sahyoun
>            Assignee: Maruan Sahyoun
>            Priority: Minor
>             Fix For: 3.0.0 PDFBox
>
>
> The command line tools shall be enhanced to have the same behavior across all 
> tools.
> From the discussion on the dev mailing list
> - add an -h option to print the usage
> - print the usage to System.err and use an exit code of 1 if there was an 
> invalid command line parameter
> - print messages on exceptions to System.err
> - rethrow the exception so java can handle it if it will terminate afterwards 
> anyway
> - use an exit code of 1if rethrowing doesn't make sense
> Additional input:
> https://clig.dev/



--
This message was sent by Atlassian Jira
(v8.3.4#803005)

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@pdfbox.apache.org
For additional commands, e-mail: dev-h...@pdfbox.apache.org

Reply via email to