Recognizes if input is ogg or not.
[xiph.git] / positron / doc / positron.1
blob98956a75920c0a35a97d811fa26845f058ceb149
1 .\" Process this file with
2 .\" groff -man -Tascii positron.1
3 .\" 
4 .\" 
5 .TH "positron" "1" "1.1" "" "Xiph.org"
6 .SH "NAME"
7 positron \- Neuros Synchronization Manager for Linux
9 .SH "SYNOPSIS"
10 .B positron
12 .B add
13 .I file(s)
16 .B sync
19 .B sync \-\-reset\-deleted
22 .B sync \-\-reset\-recordings
25 .B del
26 .I file(s)
29 .B config
32 .B rebuild
35 .B list
38 .B clear
41 .B pack
44 .B help
45 .I command
48 .B \-m
49 .I mountpoint
52 .B \-c
53 .I directory
55 .SH "DESCRIPTION"
56 .B positron
57 is a synchronization tool for the Neuros portable music player.
58 .SH "COMMAND SUMMARY"
59 .IP "add"
60 Adds files to the Neuros databases, copying as necessary
61 .IP "sync"
62 Synchronizes your Neuros with your music library
63 .IP "del"
64 Removes files from the database and disk
65 .IP "config"
66 Create or modify the current configuration
67 .IP "rebuild"
68 Recreates the positron databases
69 .IP "list"
70 Lists files in the database
71 .IP "clear"
72 Clears all entries from databases without removing any files
73 .IP "pack"
74 Removes unused space from databases
75 .IP "\-m"
76 Specify a mountpoint
77 .IP "\-c"
78 Specify an alternate config directory
79 .SH "COMMAND DETAIL"
80 .PP 
81 .B  positron sync
82 .RS
83 Copies any new music tracks from the directories specified
84 in the configuration file to the Neuros. It also copies new
85 FM or microphone recordings from the Neuros to your computer.
86 Positron remembers which tracks have been removed with
87 .B  positron del
88 and will not add them again when you sync.
89 .RE
90 .PP 
91 .B  positron sync \-\-reset\-deleted
92 .RS
93 Clears the list of deleted files.
94 .RE
95 .PP 
96 .B  positron sync \-\-reset\-recordings
97 .RS
98 Clears the list of already\-transferred recordings.
99 .RE
100 .PP 
101 .B  positron add <sourcefile> <targetfile>
103 Copies sourcefile to targetfile (path on the Neuros that does not exist).
105 .PP 
106 .B  positron add <sourcefile1> <sourcefile2> ... <targetdir>
108 Copies sourcefiles to targetdir (a directory on the Neuros that already exists).
110 .PP 
111 .B  positron add <sourcefile1> <sourcefile2> ...
113 Copies sourcefiles to the default music directory.
115 .PP 
116 Files that are already on the Neuros will not be overwritten, but just added to the database if not already present. Non\-music files are ignored.
117 .PP 
118 .B  positron del [files or directories]
120 Deletes a list of files and/or directories on the Neuros itself (ex: /mnt/neuros/music/rock) to be removed. Both the file on disk and the database entries are deleted.
122 .PP 
123 Only files referenced in the database will be removed, as well as empty directories.
124 .PP 
125 .B  positron config
127 Asks several questions and creates a new configuration set. Also allows the current configuration to be edited.
129 .PP 
130 .B  positron rebuild
132 Rebuilds all the databases from scratch. Positron will locate all of the music files already on the Neuros and put their entries back into your databse as best as it can guess. The database of music stored on your computer ("pcaudio") is cleared and all HiSi clips will be marked as unidentified.
134 .PP 
135 .B  positron list
137 List files in the audio database.
139 .PP 
140 .B  positron list <database1> <database2> ...
142 Lists all entries from a particular database. Valid database names are: audio, pcaudio, unidedhisi, idedhisi, failedhisi.
144 .PP 
145 .B  positron clear
147 Clears all databases.
149 .PP 
150 .B  positron clear <database1> <database2> ...
152 Clears all entries from a particular database. Valid database names are: audio, pcaudio, unidedhisi, idedhisi, failedhisi.
154 .PP 
155 The clear command never removes files.
156 .SH "AUTHORS"
157 .TP 
158 Program Author:
159 .br 
160 Stan Seibert <volsung@xiph.org>
162 .TP 
163 Manpage Author:
164 .br 
165 Manuel Lora <vanguardist@xiph.org>
166 .SH "SEE ALSO"
167 Move along, nothing to see here. \- Officer Barbrady