home *** CD-ROM | disk | FTP | other *** search
/ PCNET 2006 September - Disc 1 / PCNET_CD_2006_09.iso / linux / puppy-barebones-2.01r2.iso / pup_201.sfs / usr / share / doc / xarchive.txt < prev    next >
Encoding:
Text File  |  2005-11-19  |  11.9 KB  |  360 lines
  1. XARCHIVE(1)
  2. ===========
  3. Lee Bigelow <ligelowbee@yahoo.com>
  4. v0.2.6-2,  8 November 2005 
  5.  
  6. NAME
  7. ----
  8. XArchive - a gtk2.0 frontend for various command line archivers.
  9.  
  10. SYNOPSIS
  11. --------
  12. *xarchive* [-a 'archive' | -c 'archive'] [files...]
  13.  
  14. DESCRIPTION
  15. -----------
  16. XArchive is graphical frontend that uses external wrappers to communicate
  17. with the command line archiving tools.  XArchive handles creation, extraction
  18. and manipulation of archives depending on wether or not the command line tools
  19. (and the wrappers written for them) support those actions.  The types of
  20. archives supported depends on what wrappers are available in XArchive's wrapper
  21. directories (see WRAPPERS below), and what command line tools are installed.
  22.  
  23. Currently there are bash shell wrappers for: 
  24.  
  25. *tar*:: 
  26.     using tar, bzip2, gzip, and compress
  27.  
  28. *rar*:: 
  29.     using rar, or unrar(unrar only cannot modify rar's)
  30.  
  31. *zip*:: 
  32.     using unzip, zipinfo(from unzip), and zip
  33.  
  34. *ace*:: 
  35.     using unace (extraction only)
  36.  
  37. *7zip*::
  38.     using 7za from p7zip
  39.  
  40. *arj*::
  41.     using arj
  42.  
  43. *rpm*::
  44.     using rpm and cpio (extract only, use appropriate packing tools to modify)
  45.  
  46. *deb*::
  47.     using dpkg-deb from dpkg (extract only, use appropriate tools to modify)
  48.  
  49. OPTIONS
  50. -------
  51. *-a* 'archive'::
  52.     Add passed 'files' to 'archive'.  
  53.     * Normally the passed 'archive' file is opened, and a multi-file selector
  54.       is presented with any passed 'files' already added to the
  55.       selection list.
  56.     * However, if the 'archive' filename passed is 'ask', or the
  57.       passed 'archive' file cannot be found, then a dialog will be presented
  58.       asking wether to create a new archive or use an existing
  59.       one.  An appropriate chooser will then be presented for finding,
  60.       or creating, an archive to add to.  Once an archive is found, or
  61.       created, a multi-file selector will be presented with any passed
  62.       'files' already added to the selection list.
  63.  
  64. *-c* 'archive':: 
  65.      Create a new archive file named 'archive' with passed
  66.      'files'.  
  67.      * A dialog will be presented asking for an archive name.  If the
  68.        'archive' name passed is 'ask' then a generic sample filename
  69.        will be shown.  Otherwise the passed 'archive' name with be
  70.        shown.  On accepting the name is checked to make sure the file
  71.        doesn't already exist, and that a wrapper for that type of
  72.        'archive' is present.  Thus the 'archive' name should contain
  73.        the extention of the archive type that is desired
  74.        (eg. test.zip).  Once a valid archive name is accepted a
  75.        muli-file selector is presented with any passed 'files' already
  76.        added to the selection list.  
  77.  
  78. USAGE
  79. -----
  80. When XArchive starts it consults each wrapper it finds in it's wrapper
  81. directories (see WRAPPERS below) to see what file types it can support.
  82.  
  83. If XArchive is started without being passed any files to open, or any
  84. options, an information page is shown detailing what wrappers were
  85. found and what file types are (based on file extentions) supported by
  86. those wrappers
  87.  
  88. If some 'files' to open are passed to XArchive without any options it
  89. will treat them as archives and attempt to use the wrappers associated
  90. with those archives (based on file extentions) to get, and show, the
  91. contents of each.
  92.  
  93. The '-a' and '-c' options allow you to use XArchive with your
  94. filemanager to add to an existing archive, or to create a new one.
  95.  
  96. Using 'xarchive -a ask' as your filemanager's "open with" command on
  97. some selected files will allow you add those selected files to an
  98. existing archive (xarchive will ask which archive to add them too).
  99.  
  100. Using just 'xarchive -a' as your filemanager's "open with" command on a
  101. selected archive file will allow you open that archive and use
  102. XArchive's multi-file selector to choose the files to add to it.
  103.  
  104. Using 'xarchive -c ask' as your filemanager's "open with" command on
  105. some selected files allows you to create a new archive containing
  106. those files (XArchive will ask you for the new archive's name).  This
  107. option won't allow opening an existing archive and guarantees that a
  108. unique one is created.
  109.  
  110. Once and archive is opened it's entries can be selected to delete,
  111. extract, or openwith.  You can use the following selection methods: 
  112.  
  113. *Left-Click*::
  114.     To select one file, and unselect all others.  If that one file is
  115.     a directory it's contents will also be selected.
  116.  
  117. *CTRL + Left-Click*:: 
  118.     To select/unselect multiple files.  Hold down the Control Key while
  119.     Left-Clicking individual files to toggle their selection state.
  120.     If the file clicked is a directory it's contents will also be
  121.     selected or unselected.  
  122.  
  123. *SHIFT + Left-Click*:: 
  124.     To select a block of files.  Select the first file in the block normally
  125.     (just a Left-Click), then Shift + Left Click the last file
  126.     in the block and all the files in between will also be selected.
  127.  
  128. *Right-Click* on an archive listing will bring up a context
  129. menu with the actions from the toolbar on it.
  130.  
  131. *Double-Left-Click* on an entry will temporarily extract
  132. that file from the archive and use the default handler to view it.  If
  133. no default handler has been set the "open with.." dialog is opened so
  134. that you can set one.
  135.  
  136. About "Open With"
  137. ~~~~~~~~~~~~~~~~~
  138.  
  139. 'Open with' will temporarily extract selected files and view them with
  140. the user selected application.  From this dialog you can also set an
  141. application as the 'default double-click handler' by clicking that
  142. option's checkbox.  Setting this allows you to double left click
  143. entries in the listing and have them viewed with the set application.
  144.  
  145. Note:  When picking an 'open with' application you should make sure
  146. that application doesn't fork to the background.  If it does then the
  147. temporary file that was extracted will most likely be deleted before
  148. the application can view it.  For example, 'gvim' will fork to the
  149. background, so instead you should use 'gvim --nofork'.
  150.  
  151. About Creating Archives
  152. ~~~~~~~~~~~~~~~~~~~~~~~
  153.  
  154. When you select 'New' you will be asked for an archive name.  The
  155. extension you use on your name will determine what kind of archive is
  156. created.  For example using 'mywebstuff.zip' will create a zip, and
  157. 'mywebsutff.tar.bz2' will create a bzip2 compressed tar.
  158.  
  159. Then, in the same dialog, you'll select the folder you want to save
  160. the archive in.  When that's done, and you press 'open' the multiple
  161. file selector will be opened.
  162.  
  163. The multiple file selector allows you to browse around the file system
  164. and pick off what files and directories you wish to add to your
  165. archive.  Just select the files in the 'file chooser' list and press
  166. the 'add to list' button.  To remove files from the 'add to archive'
  167. list, select the files and press the 'remove from list' button.
  168.  
  169. Note that the the full path for the file or directory will be listed
  170. in the 'add to archive' list for your reference, but when the archive
  171. is made only the basename of the entry will be added.  For example, if
  172. the '/home/me/html' directory is on the list to be added then the
  173. archive will contain the directory 'html' (and it's contents), not
  174. it's full path (the '/home/me' part is discarded).  This is a good
  175. thing.  When you send someone your archive, and they extract it, you
  176. probably don't want it trying to create a /home/me/html directory tree
  177. on your buddies machine.
  178.  
  179. KEYBOARD SHORTCUTS
  180. ------------------
  181. Main Archive Listing
  182. ~~~~~~~~~~~~~~~~~~~~
  183. CTRL + Q:: 
  184.      quit
  185.  
  186. CTRL + O:: 
  187.      open an existing archive
  188.  
  189. CTRL + N:: 
  190.      create a new archive
  191.  
  192. CTRL + W:: 
  193.      close the current archive window
  194.  
  195. CTRL + S:: 
  196.      select all files in archive
  197.  
  198. CTRL + U:: 
  199.      unselect all files in archive
  200.  
  201. CTRL + E:: 
  202.      extract selected files from archive
  203.  
  204. CTRL + P::
  205.      temorarily extract selected files and view them 
  206.      with a user specified application.
  207.      (has command history, saved in ~/.xarchive/cmd_history)
  208.  
  209. CTRL + R:: 
  210.      remove selected files from archive
  211.  
  212. CTRL + A:: 
  213.      add files to archive
  214.  
  215. CTRL + H::
  216.      read the help file
  217.  
  218. CTRL + I::
  219.      show wrapper information
  220.  
  221. File and Directory Chooser
  222. ~~~~~~~~~~~~~~~~~~~~~~~~~~
  223.  
  224. ALT + UP::
  225.     move up to parent directory
  226.  
  227. ALT + DOWN::
  228.     move down a direcory
  229.  
  230. ALT + HOME::
  231.     move to home directory
  232.  
  233. CTRL + L::
  234.      ask for a specific location to move to
  235.  
  236. ALT + A::
  237.     if on a directory in the 'File Chooser', add a shortcut for it to the 'Folder Shortcuts List'
  238.  
  239. ALT + R::
  240.     if on a shortcut in the 'Folder Shortcuts List', remove it from the list
  241.  
  242. ALT + O::
  243.     OK 
  244.  
  245. ALT + C::
  246.     Cancel
  247.  
  248. (Note: To select hidden directories right click on the file listing and select
  249. "show hidden files" from the popup menu)
  250.  
  251. "Add to Archive" Selector
  252. ~~~~~~~~~~~~~~~~~~~~~~~~~
  253. The same as the File and Directory Chooser with the following added:
  254.  
  255. ALT + T::
  256.     add selected files in the 'File Chooser' to the 'Add To Archive List' below it
  257.  
  258. ALT + F:: 
  259.     remove selected files from the 'Add to Archive List' (can also be activated by a right-click on the list)
  260.  
  261. WRAPPERS
  262. --------
  263. XArchive checks the following directories, in the following order, for 
  264. it's wrappers:
  265.  
  266. - ~/.xarchive/wrappers/
  267.  
  268. - /usr/local/lib/xarchive/wrappers/
  269.  
  270. - (or, depending on installation /usr/lib/xarchive/wrappers/)
  271.  
  272. The first wrappers found are the first ones used.  Thus, if you copy a wrapper
  273. from the system wide directory (/usr/local/lib/xarchive/wrappers/) to your own
  274. private wrapper directory (~/.xarchive/wrappers/) and modify it, your modified
  275. version will be used.
  276.  
  277. The wrappers are stand alone executables whose job is to:
  278.  
  279. - When asked what files it supports, check to see if the command line tools it
  280.   needs are installed and tell XArchive what types of files it supports based
  281.   on what's installed.
  282.  
  283. - When asked for the contents of an archive, take the output from the command
  284.   line tools it uses and mangle it into the format XArchive likes
  285.  
  286. - When sent an action to preform, take the requested action from
  287.   XArchive and send the command line tool the appropriate options to prefrom
  288.   said action.  
  289.  
  290. Wrappers can be any type of executable file (python scripts, c programs, bash
  291. scripts, etc...) that handle the following options in the following manner:
  292.  
  293. -i::  
  294.     'Info:' Check to see if command line programs are installed and return a
  295.     line containing a semicolon separated list of supported file extentions
  296.     based on what's installed.  eg: 
  297.         * tar;tar.gz;tar.bz2;tar.z;tgz;tbz;tbz2
  298.  
  299. -o archive::
  300.     'Open:' Use command line tools to get contents of "archive" and return
  301.     contents in the format XArchive accepts.  Each entry in the archive on a
  302.     separate line like so:
  303.         * file1;size;attributes;user;group;date;time;linkinfo
  304.         * file2;size;attributes;user;group;date;time;linkinfo
  305.         * file3;size;attributes;user;group;date;time;linkinfo
  306.         * (note: all fields must be present, so if there's no data for a field
  307.            fill it with a "-", or a space if you like.)
  308.  
  309. -a archive files::
  310.     'Add:' Add to "archive" the "files" sent.  File names sent are escaped to
  311.     be bash friendly by XArchive.
  312.  
  313. -n archive file::
  314.     'New:' create a new archive "archive" with single file "file".  (other files
  315.     selected to be put in new archive will be "added" after creation.)
  316.  
  317. -r archive files::
  318.     'Remove:' remove from "archive" sent "files"
  319.  
  320. -e archive files::
  321.     'Extract:' extract from "archive" sent "files" into the current dir.
  322.     XArchive changes into a user selected directory before sending this
  323.     command.
  324.  
  325. Wrapper Exit Codes
  326. ~~~~~~~~~~~~~~~~~~
  327. - 0  success
  328.  
  329. - 65 unsupported action for this archive type
  330.  
  331. - Anything else for wrapper failure
  332.  
  333. See the wrappers included in /usr/local/lib/xarchive/wrappers (or /usr/lib/xarchive/wrappers) for examples.
  334.  
  335. BUGS 
  336. ---- 
  337. Use bug tracker on the sourceforge project page:
  338.  
  339. http://sourceforge.net/projects/xarchive/[]
  340.  
  341. AUTHOR
  342. ------
  343. Written by Lee Bigelow <ligelowbee@yahoo.com> 
  344.  
  345. RESOURCES
  346. ---------
  347. SourceForge: 
  348.  
  349. http://sourceforge.net/projects/xarchive/[]
  350.  
  351. Main web site: 
  352.  
  353. http://xarchive.sourceforge.net[]
  354.  
  355. COPYING
  356. -------
  357. Copyright (C) 2005 Lee Bigelow <ligelowbee@yahoo.com>. Free use of this software is
  358. granted under the terms of the GNU General Public License (GPL).
  359.  
  360.