github.com/jstaf/onedriver@v0.14.2-0.20240420231225-f07678f9e6ef/pkg/resources/onedriver.1 (about)

     1  .\" Manpage for onedriver
     2  
     3  .TH man 1 "Nov 2021" "0.14.1" "onedriver man page"
     4  
     5  .SH NAME
     6  onedriver \- A native Linux client for Microsoft OneDrive.
     7  
     8  
     9  .SH SYNOPSIS
    10  .BR onedriver " [" \fIOPTION\fR "] <\fImountpoint\fR>
    11  
    12  
    13  .SH DESCRIPTION
    14  This program will mount your OneDrive account as a Linux filesystem at the
    15  location specified by \fImountpoint\fR. Note that this is not a sync client -
    16  files are fetched on-demand and cached locally. Only files you actually use will
    17  be downloaded. While offline, the filesystem will be read-only until
    18  connectivity is re-established.
    19  
    20  
    21  .SH OPTIONS
    22  
    23  .TP
    24  .BR \-a , " \-\-auth-only"
    25  Authenticate to OneDrive and then exit.
    26  
    27  .TP
    28  .BR \-f , " \-\-config-file"
    29  A YAML-formatted configuration file used by onedriver. Defaults to
    30  "~/.config/onedriver/config.yml".
    31  
    32  .TP
    33  .BR \-c , " \-\-cache\-dir " \fIdir
    34  Change the default cache directory used by onedriver. Will be created if the
    35  path does not already exist. The \fIdir\fR argument specifies the location. 
    36  
    37  .TP
    38  .BR \-d , " \-\-debug"
    39  Enable FUSE debug logging. This logs communication between onedriver and the kernel.
    40  
    41  .TP
    42  .BR \-h , " \-\-help"
    43  Displays a help message.
    44  
    45  .TP
    46  .BR \-l , " \-\-log "\fIlevel
    47  Set logging level/verbosity. \fIlevel\fR can be one of: 
    48  .BR fatal ", " error ", " warn ", " info ", " debug " or " trace " (default is " debug ")."
    49  
    50  .TP
    51  .BR \-n , " \-\-no\-browser"
    52  This disables launching the built-in web browser during authentication. Follow
    53  the instructions in the terminal to authenticate to OneDrive.
    54  
    55  .TP
    56  .BR \-v , " \-\-version"
    57  Display program version.
    58  
    59  .TP
    60  .BR \-w , " \-\-wipe-cache"
    61  Delete the existing onedriver cache directory and then exit. Equivalent to
    62  resetting the program.
    63  
    64  
    65  .SH SYSTEM INTEGRATION
    66  To start onedriver automatically and ensure you always have access to your
    67  files, you can start onedriver as a systemd user service. In this example,
    68  \fImountpoint\fR refers to where we want OneDrive to be mounted at (for
    69  instance, ~/OneDrive). Mounting OneDrive via systemd allows multiple drives to
    70  be mounted at the same time (as long as they use different mountpoints).
    71  
    72  
    73  .TP
    74  Create the mountpoint and determine the service name:
    75  .nf
    76  \fB
    77  mkdir -p \fImountpoint\fR  
    78  \fB
    79  export SERVICE_NAME=$(systemd-escape --template onedriver@.service --path \fImountpoint\fR)
    80  \fR
    81  .fi
    82  
    83  .TP
    84  Mount OneDrive:
    85  .nf
    86  \fB
    87  systemctl --user daemon-reload
    88  systemctl --user start $SERVICE_NAME
    89  \fR
    90  .fi
    91  
    92  .TP
    93  Mount OneDrive on login:
    94  .nf
    95  \fB
    96  systemctl --user enable $SERVICE_NAME
    97  \fR
    98  .fi
    99  
   100  .TP
   101  Check onedriver's logs:
   102  .nf
   103  \fB
   104  journalctl --user -u $SERVICE_NAME
   105  \fR
   106  .fi
   107  
   108  
   109  .SH TROUBLESHOOTING
   110  
   111  Most errors can be solved by simply restarting the program. onedriver is
   112  designed to recover cleanly from errors with no extra effort.
   113  
   114  It's possible that there may be a deadlock or segfault that I haven't caught in 
   115  my tests. If this happens, the onedriver filesystem and subsequent ops may hang
   116  indefinitely (ops will hang while the kernel waits for the dead onedriver 
   117  process to respond). When this happens, you can cleanly unmount the filesystem 
   118  with: \fBfusermount3 -uz $MOUNTPOINT\fR
   119  
   120  
   121  In the event that you want to reset onedriver completely (wipe all local state)
   122  you can do so via: \fBonedriver -w\fR
   123  
   124  
   125  .SH KNOWN ISSUES AND DISCLAIMER
   126  
   127  Many file browsers (like GNOME's Nautilus) will attempt to automatically 
   128  download all files within a directory in order to create thumbnail images.
   129  This is somewhat annoying, but only needs to happen once - after the initial
   130  thumbnail images have been created, thumbnails will persist between
   131  filesystem restarts.
   132  
   133  Microsoft does not support symbolic links (or anything remotely like them) on
   134  OneDrive. Attempting to create symbolic links within the filesystem returns
   135  ENOSYS (function not implemented) because the functionality hasn't been
   136  implemented... by Microsoft. Similarly, Microsoft does not expose the OneDrive
   137  Recycle Bin APIs - if you want to empty or restore the OneDrive Recycle Bin, you
   138  must do so through the OneDrive web UI (onedriver uses the native system
   139  trash/restore functionality independently of the OneDrive Recycle Bin).
   140  
   141  This project is still in active development and is provided AS IS. There are no
   142  guarantees. It might kill your cat.
   143  
   144  
   145  .SH SEE ALSO
   146  Further information can be found at https://github.com/jstaf/onedriver